java代码格式化模板（阿里代码规范）

文件准备

网盘文件：https://pan.baidu.com/s/1LKQF-JkUCgBh8ziG71UfEg

文件	说明
p3c-formatter	模板文件
EclipseFormatter.zip	idea插件
阿里巴巴Java开发手册（详尽版）.pdf	代码规范手册

官方文件：

• 格式化模板文件下载地址：https://github.com/alibaba/p3c/tree/master/p3c-formatter

文件名	作用
eclipse-codestyle.xml	代码格式化时用的模板
eclipse-codetemplate.xml	注释模板

两个模板文件

一、eclipse 格式化设置

1. 格式化模板导入

   • 依次点击：Window->Preferences->Java->Code Style->Formatter->Import
   • 选择eclipse-codestyle.xml文件确定
   • 默认在Active profile中选择新导入的P3C-CodeStyle，如未选择，请手动选择
   • 点击Apply完成配置
     eclipse模板文件导入

2. 注释模板导入

   • 操作流程同上，Window->Preferences->Java->Code Style->Code Templates->Import
   • 勾选Automatically add comments for new methods and types
   • 点击Apply完成配置
     image.png

3. properties文件编码UTF-8

   • Window->Preferences->General->Content Types->Text->Java Properties File
   • 将Java Properties File及下属的所有项均设定为 Default encoding: UTF-8
     image.png

二、idea 格式化配置

1. 安装EclipseCodeFormatter插件

   • 因为阿里配置文件是针对eclipse的，所有要导入配置文件需要额外安装EclipseFormatter插件
   • 在线安装，需翻墙。依次点击进入插件界面：File->Settings->Plugins，搜索 eclipse code formatter，如已有插件则不需安装，如没有，点击Search in repositories自动搜索线上插件。
     在线安装EclipseCodeFormatter
   • 离线安装：下载插件文件，在Plugins界面中选择Install plugin from disk，选择已下载好的 EclipseFormatter.zip文件，确定并重启idea。
   • 下载地址：https://github.com/krasa/EclipseCodeFormatter/releases
     image.png

2. 导入eclipse-codestyle.xml
   

   导入eclipse-codestyle.xml

3. 设置类的注释格式

   • 进入Settings界面 Editor->File and Code Templates->File Header，右侧输入注释模板
     设置类的注释格式
   • 代码片段

/**
* @author  ${USER}
* @since ${DATE} ${TIME} 
*/