{"id":10020422,"date":"2024-11-28T13:44:31","date_gmt":"2024-11-28T05:44:31","guid":{"rendered":"https:\/\/itmax.cn\/?p=10020422"},"modified":"2024-11-28T13:44:31","modified_gmt":"2024-11-28T05:44:31","slug":"java%e4%bb%a3%e7%a0%81%e4%b9%8b%e7%be%8e%ef%bc%8c%e4%bb%8e%e9%81%b5%e5%be%aa%e6%a0%b7%e5%bc%8f%e8%a7%84%e8%8c%83%e5%bc%80%e5%a7%8b","status":"publish","type":"post","link":"https:\/\/itmax.cn\/?p=10020422","title":{"rendered":"Java\u4ee3\u7801\u4e4b\u7f8e\uff0c\u4ece\u9075\u5faa\u6837\u5f0f\u89c4\u8303\u5f00\u59cb"},"content":{"rendered":"

\u4f5c\u8005\uff1a\u4eac\u4e1c\u96f6\u552e \u5218\u4ef2\u4f1f<\/p>\n

\"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n<\/p>\n

\u5728\u8f6f\u4ef6\u5f00\u53d1\u7684\u4e16\u754c\u91cc\uff0c\u4ee3\u7801\u4e0d\u4ec5\u662f\u7a0b\u5e8f\u7684\u57fa\u77f3\uff0c\u66f4\u662f\u7a0b\u5e8f\u5458\u4ea4\u6d41\u7684\u901a\u7528\u8bed\u8a00\u3002\u800cJava\uff0c\u4f5c\u4e3a\u4e00\u95e8\u5e7f\u6cdb\u5e94\u7528\u4e8e\u4f01\u4e1a\u7ea7\u5e94\u7528\u7684\u7f16\u7a0b\u8bed\u8a00\uff0c\u5176\u4ee3\u7801\u7684\u53ef\u8bfb\u6027\u548c\u4e00\u81f4\u6027\u5bf9\u4e8e\u9879\u76ee\u7684\u957f\u671f\u7ef4\u62a4\u548c\u56e2\u961f\u534f\u4f5c\u81f3\u5173\u91cd\u8981\u3002\u672c\u6587\u5c06\u5e26\u4f60\u63a2\u7d22Java\u4ee3\u7801\u7684\u7f8e\u5b66\uff0c\u63ed\u793a\u90a3\u4e9b\u80fd\u591f\u8ba9\u4f60\u7684\u4ee3\u7801\u65e2\u7f8e\u89c2\u53c8\u9ad8\u6548\u7684\u6837\u5f0f\u89c4\u8303\u3002\u65e0\u8bba\u662f\u521d\u51fa\u8305\u5e90\u7684\u65b0\u624b\u8fd8\u662f\u7ecf\u9a8c\u4e30\u5bcc\u7684\u8001\u624b\uff0c\u90fd\u80fd\u4ece\u4e2d\u83b7\u5f97\u7075\u611f\uff0c\u63d0\u5347\u7f16\u7801\u7684\u827a\u672f\u3002<\/p>\n

\u4e00\u3001\u4e3a\u4ec0\u4e48\u8981\u4ee3\u7801\u6837\u5f0f\u89c4\u8303<\/h2>\n

\u5bf9\u4e8e\u56e2\u961f\u5f00\u53d1\uff0c\u4e0d\u540c\u7684\u4ee3\u7801\u89c4\u8303\u6216\u4e0d\u89c4\u8303\u53ef\u80fd\u5f15\u8d77\u7684\u95ee\u9898\u5305\u62ec\u4f46\u4e0d\u9650\u4e8e\uff1a<\/p>\n

1.\u4ee3\u7801\u53ef\u8bfb\u6027\uff0c\u4ee3\u7801\u662f\u4e3a\u4e86\u4eba\u9605\u8bfb\u7684\uff0c\u4e0d\u662f\u53ea\u4e3a\u4e86\u673a\u5668\u6267\u884c\uff1b<\/p>\n

2.\u4ee3\u7801format\u5f15\u53d1\u7684\u5927\u91cf\u7684diff\uff0c\u5e72\u6270code review\uff1b<\/p>\n

3.\u95f4\u63a5\u5f71\u54cd\u4ee3\u7801\u8d28\u91cf\u548c\u56e2\u961f\u534f\u4f5c\u6548\u7387\uff1b<\/p>\n

\u5728\u654f\u6377\u8fed\u4ee3\u7684\u8f6f\u4ef6\u5f00\u53d1\u73af\u5883\u4e2d\uff0c\u826f\u597d\u7684\u4ee3\u7801\u89c4\u8303\u4e0d\u4ec5\u80fd\u591f\u5e2e\u52a9\u56e2\u961f\u6210\u5458\u5feb\u901f\u7406\u89e3\u5f7c\u6b64\u7684\u4ee3\u7801\uff0c\u51cf\u5c11\u6c9f\u901a\u6210\u672c\uff0c\u8fd8\u80fd\u5728\u4ee3\u7801\u7ef4\u62a4\u548c\u6269\u5c55\u65f6\u8282\u7701\u5b9d\u8d35\u7684\u65f6\u95f4\u3002\u6b64\u5916\uff0c\u4e00\u81f4\u7684\u4ee3\u7801\u98ce\u683c\u4e5f\u662f\u9879\u76ee\u4e13\u4e1a\u6027\u7684\u4f53\u73b0\uff0c\u80fd\u591f\u7ed9\u4ee3\u7801\u5ba1\u67e5\u8005\u548c\u672a\u6765\u7684\u7ef4\u62a4\u8005\u7559\u4e0b\u826f\u597d\u7684\u7b2c\u4e00\u5370\u8c61\u3002<\/p>\n<\/p>\n

\u4e8c\u3001\u63a2\u7d22Java\u4ee3\u7801<\/strong>\u89c4\u8303<\/h2>\n

\u6211\u4eec\u5c06\u6df1\u5165\u63a2\u8ba8Java\u793e\u533a\u5e7f\u6cdb\u8ba4\u53ef\u7684\u7f16\u7801\u89c4\u8303\uff0c\u5305\u62ec\u4f46\u4e0d\u9650\u4e8eGoogle Java Style\u548cOracle\u5b98\u65b9\u7684\u7f16\u7801\u6307\u5357\u3002\u4ece\u547d\u540d\u7ea6\u5b9a\u3001\u4ee3\u7801\u683c\u5f0f\u5316\u3001\u6ce8\u91ca\u7684\u4f7f\u7528\uff0c\u5230\u9519\u8bef\u5904\u7406\u548c\u6d4b\u8bd5\u4ee3\u7801\u7684\u7f16\u5199\uff0c\u6bcf\u4e00\u4e2a\u7ec6\u8282\u90fd\u662f\u6784\u5efa\u9ad8\u8d28\u91cfJava\u4ee3\u7801\u7684\u5173\u952e\u3002<\/p>\n

2.1 \u4e1a\u754cJava\u4ee3\u7801\u6837\u5f0f\u89c4\u8303<\/h3>\n

a. Google Java Style<\/h4>\n

Google\u5728github\u4e0a\u7ef4\u62a4\u7684\u591a\u79cd\u7f16\u7a0b\u8bed\u8a00\u7684\u4ee3\u7801\u89c4\u8303\uff1ahttps:\/\/github.com\/google\/styleguide<\/a>\uff0c\u5176\u4e2d\uff1a<\/p>\n

\u2022javaguide.html<\/a> \u662fGoogle\u5bf9Java\u7f16\u7a0b\u8bed\u8a00\u4ee3\u7801\u7f16\u7801\u6807\u51c6\u7684\u5b8c\u6574\u5b9a\u4e49\uff1b<\/p>\n

\u2022intellij-java-google-style.xml<\/a> \u662fGoogle Java\u4ee3\u7801\u89c4\u8303\u6587\u4ef6\uff0c\u9002\u7528\u4e8eIntellij IDEA\u5f00\u53d1\u5de5\u5177\uff1b<\/p>\n

b. \u963f\u91ccJava\u89c4\u8303<\/h4>\n

\u963f\u91cc\u5728 GitHub \u4e0a\u6709\u4e00\u4e2a\u5173\u4e8e Java \u5f00\u53d1\u89c4\u8303\u7684\u4ed3\u5e93 p3c\uff1ahttps:\/\/github.com\/alibaba\/p3c\uff0c<\/a>\u5176\u4e2d\uff1a<\/p>\n

\u2022Java\u5f00\u53d1\u624b\u518c(\u9ec4\u5c71\u7248).pdf<\/a> \u8986\u76d6\u7f16\u7a0b\u89c4\u7ea6\u3001\u5f02\u5e38\u65e5\u5fd7\u3001\u5355\u5143\u6d4b\u8bd5\u7b49\u4e03\u4e2a\u7ef4\u5ea6\uff1b<\/p>\n

\u2022Alibaba Java Coding Guidelines<\/a> Jetbrains\u63d2\u4ef6\u5e02\u573a\u63d0\u4f9b\u7684\u4ee3\u7801\u6307\u5bfc\u63d2\u4ef6\uff0c idea-plugin<\/a> \u63d0\u4f9b\u7f16\u8bd1\u3001\u5b89\u88c5\u3001\u4f7f\u7528\u624b\u518c\uff1b<\/p>\n

c. \u5176\u5b83\u89c4\u8303<\/h4>\n\n\n\n\n\n\n\n\n
\u516c\u53f8\/\u7ec4\u7ec7<\/strong><\/th>\nStyle Guide<\/strong><\/th>\n<\/tr>\n<\/thead>\n
Sun\/Oracle<\/td>\nThe Original Sun Java Style Guide<\/a><\/td>\n<\/tr>\n
Andriod<\/td>\nAndroid Open Source Project (AOSP) Style Guide<\/a><\/td>\n<\/tr>\n
Twitter<\/td>\nTwitter\u2019s Java Style Guide<\/a><\/td>\n<\/tr>\n
Coderanch<\/td>\nThe CodeRanch Style Guide<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

2.2 \u89c4\u8303\u9009\u62e9\u4e0e\u5236\u5b9a<\/h3>\n

a. \u89c4\u8303\u9009\u62e9<\/h4>\n

\u4e0a\u9762\u5217\u4e3e\u4e86\u591a\u9879\u4ee3\u7801\u89c4\u8303\uff0c\u5728\u51b3\u5b9a\u4f7f\u7528\u54ea\u79cd\u89c4\u8303\u4e4b\u524d\uff0c\u53ef\u4ee5\u8003\u8651\u4e09\u4e2a\u65b9\u9762\uff1a<\/p>\n

\u2022\u660e\u786e\u76ee\u6807\uff1a\u4f7f\u7528\u4ee3\u7801\u89c4\u8303\u7684\u76ee\u7684\u662f\u4ec0\u4e48\uff0c\u53ea\u662f\u4e3a\u4e86\u9879\u76ee\u5185\u4ee3\u7801\u98ce\u683c\u4e00\u81f4\uff0c\u8fd8\u662f\u4e3a\u4e86\u548c\u5176\u4ed6\u56e2\u961f\u5206\u4eab\u6216\u8005\u5176\u4ed6\u516c\u53f8\u5206\u4eab\u6216\u8005\u5f00\u6e90\uff1f<\/p>\n

\u2022\u4f7f\u7528\u73af\u5883\uff1a\u5f00\u53d1\u9605\u8bfb\u4ee3\u7801\u7684\u73af\u5883\u662f\u4ec0\u4e48\uff0cGitHub\u3001GitLab\u3001\u516c\u53f8\u5185\u90e8\u7684Coding\uff1f<\/p>\n

\u2022\u5de5\u5177\u652f\u6301\uff1acode format\u5de5\u5177\u652f\u6301\u60c5\u51b5\uff0ccode sytle check\u5de5\u5177\u652f\u6301\u60c5\u51b5\uff0c\u7f16\u8bd1\u5de5\u5177\uff1amaven\u3001gradle\uff0cIDE\uff1aIntelliJ\u3001Eclipse\u3001VS Code\uff1b<\/p>\n

\u7efc\u5408\u4e0a\u9762\u7684\u4e09\u4e2a\u65b9\u9762\u7684\u8003\u8651\uff0c\u4f18\u5148\u9009\u62e9Google Java Style\u3002<\/p>\n

b. \u89c4\u8303\u5236\u5b9a<\/h4>\n

Google Java Style\u90e8\u5206\u4ee3\u7801\u6837\u5f0f\u56e2\u961f\u96be\u4ee5\u63a5\u53d7\uff0c\u6bd4\u59822\u7a7a\u683c\u7f29\u8fdb\u7b49\uff0c\u53ef\u4ee5\u5728\u539f\u59cbGoogle Java Style\u57fa\u7840\u4e0a\uff0c\u9002\u5f53\u5b9a\u5236\u5316\u8c03\u6574\u3002<\/p>\n

\u2022\u4fee\u6539intellij-java-google-style.xml\u4e2d\u7684\u5185\u5bb9\uff1a<\/p>\n\n\n\n\n\n\n\n\n\n\n
option<\/th>\nprevious value<\/th>\nmodified value<\/th>\nnote<\/th>\n<\/tr>\n<\/thead>\n
INDENT\/_SIZE<\/td>\n2<\/td>\n4<\/td>\n\u884c\u7f29\u8fdb\u7a7a\u683c\u6570<\/td>\n<\/tr>\n
TAB\/_SIZE<\/td>\n2<\/td>\n4<\/td>\nTAB\u7a7a\u683c\u6570<\/td>\n<\/tr>\n
CONTINUATION\/_INDENT\/_SIZE<\/td>\n4<\/td>\n8<\/td>\n\u6362\u884c\u7f29\u8fdb\u7a7a\u683c\u6570<\/td>\n<\/tr>\n
RIGHT\/_MARGIN<\/td>\n100<\/td>\n120<\/td>\n\u5355\u884c\u957f\u5ea6<\/td>\n<\/tr>\n
JD\/_PRESERVE\/_LINE\/_FEEDS<\/td>\n\u65e0<\/td>\nTRUE<\/td>\nJavaDoc \u4e2d\uff0c\u4fdd\u7559\u624b\u52a8\u7684\u6362\u884c<\/td>\n<\/tr>\n
KEEP\/_LINE\/_BREAKS<\/td>\n\u65e0<\/td>\nTRUE<\/td>\nJava\u4ee3\u7801\u4e2d\uff0c\u4fdd\u7559\u624b\u52a8\u7684\u6362\u884c<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u2022\u4fee\u6539intellij-java-jd-style.xml\u6587\u4ef6\u4e0b\u8f7d\uff1ahttp:\/\/xingyun.jd.com\/codingRoot\/liuzhongwei18\/styleguide\/blo…<\/a><\/p>\n

2.3 \u89c4\u8303\u4f7f\u7528<\/h3>\n

\u4ee3\u7801\u6837\u5f0f\u89c4\u8303\u7684\u4f7f\u7528\u5206\u4e3a\u4e24\u4e2a\u65b9\u9762\uff1a<\/p>\n

\u2022\u4ee3\u7801\u683c\u5f0f\u5316<\/p>\n

\u2022\u4ee3\u7801\u6837\u5f0f\u6821\u9a8c<\/p>\n\n\n\n\n\n\n
\u89c4\u8303\u4f7f\u7528<\/th>\n\u82f1\u6587<\/th>\n\u4f7f\u7528\u5bf9\u8c61<\/th>\n\u4f7f\u7528\u65b9\u5f0f<\/th>\n\u8bf4\u660e<\/th>\n\u914d\u7f6e\u6587\u4ef6<\/th>\n<\/tr>\n<\/thead>\n
\u4ee3\u7801\u683c\u5f0f\u5316<\/td>\ncode style<\/td>\n\u5f00\u53d1\u8005<\/td>\nIDE\u624b\u52a8<\/td>\n\u5b9a\u4e49\u4ee3\u7801\u98ce\u683c<\/td>\nintellij-java-jd-style.xml<\/a><\/td>\n<\/tr>\n
\u4ee3\u7801\u6837\u5f0f\u6821\u9a8c<\/td>\ncheck style<\/td>\n\u56e2\u961f<\/td>\n\u81ea\u52a8\u5316<\/td>\n\u6821\u9a8c\u4ee3\u7801\u98ce\u683c<\/td>\ncheckstyle.xml<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u6ce8\u610f\uff1acode style \u8ddf check style \u7684\u300c\u914d\u7f6e\u6587\u4ef6\u300d\u5fc5\u987b\u5bf9\u5e94\uff0c\u5373\u6309\u7167code style format\u7684\u4ee3\u7801check style\u4e0d\u62a5\u9519\u3002<\/p>\n

\u4ee3\u7801\u6837\u5f0f\u6821\u9a8c<\/h4>\n

\u4ee3\u7801\u683c\u5f0f\u5316\u4f9d\u8d56\u4e8e\u5f00\u53d1\u8005\u624b\u52a8\u8fdb\u884c\u683c\u5f0f\u5316\uff0c\u4e3a\u8fbe\u5230\u56e2\u961f\/\u9879\u76ee\u4ee3\u7801\u6837\u5f0f\u89c4\u8303\u7684\u843d\u5730\uff0c\u9700\u8981\u6709\u5168\u9762\u7684\u81ea\u52a8\u5316\u7684\u4ee3\u7801\u68c0\u67e5\u3002\u6839\u636e\u5f53\u524d\u4e1a\u754c\u63a8\u8350\uff0c\u91c7\u7528Checkstyle\u4f5c\u4e3a\u81ea\u52a8\u5316\u4ee3\u7801\u6837\u5f0f\u6821\u9a8c\u5de5\u5177\u3002<\/p>\n

\u9700\u8981\u5bf9\u539f\u59cb Google Code Style \u7684google\/_checks<\/a>\u8fdb\u884c\u5b9a\u5236\uff0c\u4ee5\u9002\u914d\u4e0a\u9762intellij-java-jd-style.xml<\/a>\u7684\u5b9a\u5236\u3002<\/p>\n

\u2022\u4fee\u6539google\/_checks<\/a>\u4e2d\u7684\u5185\u5bb9\uff1a<\/p>\n\n\n\n\n\n\n
module<\/th>\nproperty<\/th>\nprevious value<\/th>\nmodified value<\/th>\nnote<\/th>\n<\/tr>\n<\/thead>\n
LineLength<\/td>\nmax<\/td>\n100<\/td>\n120<\/td>\n\u5355\u884c\u957f\u5ea6<\/td>\n<\/tr>\n
Indentation<\/td>\nbasicOffset braceAdjustment caseIndent throwsIndent lineWrappingIndentation arrayInitIndent<\/td>\n2 2 2 4 4 2<\/td>\n4 0 4 4 4 4<\/td>\n\u4f7f\u7528checkstyle\u9ed8\u8ba4\u7f29\u8fdb\u98ce\u683c<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u2022\u4fee\u6539checkstyle.xml\u6587\u4ef6\u4e0b\u8f7d\uff1ahttp:\/\/xingyun.jd.com\/codingRoot\/liuzhongwei18\/styleguide\/blo…<\/a><\/p>\n<\/p>\n

\u9664\u4e86\u4e0a\u8ff0\u7684\u957f\u5ea6\u548c\u7f29\u8fdb\u7684\u4ee3\u7801\u6837\u5f0f\u6821\u9a8c\uff0cCheckstyle\u8fd8\u53ef\u4ee5\u914d\u7f6e\u5176\u5b83\u4ee3\u7801\u6821\u9a8c\uff0c\u53ef\u6839\u636e\u56e2\u961f\u63a5\u53d7\u60c5\u51b5\u4e88\u4ee5\u914d\u7f6e\u3002<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
module<\/th>\nproperty<\/th>\ndefault value<\/th>\nnote<\/th>\n<\/tr>\n<\/thead>\n
FileLength<\/td>\nmax<\/td>\n2000<\/td>\n\u5355\u4e2a\u6587\u4ef6\u957f\u5ea6<\/td>\n<\/tr>\n
MethodLength<\/td>\nmax<\/td>\n150<\/td>\n\u5355\u4e2a\u65b9\u6cd5\u957f\u5ea6<\/td>\n<\/tr>\n
ParameterNumber<\/td>\nmax<\/td>\n7<\/td>\n\u65b9\u6cd5\u7684\u53c2\u6570\u4e2a\u6570<\/td>\n<\/tr>\n
ModifierOrder<\/td>\n<\/td>\n<\/td>\nJava\u8bed\u8a00\u89c4\u8303<\/a><\/td>\n<\/tr>\n
NestedIfDepth<\/td>\nmax<\/td>\n1<\/td>\n\u68c0\u67e5if-else\u5d4c\u5957\u5c42\u6570<\/td>\n<\/tr>\n
NestedTryDepth<\/td>\nmax<\/td>\n1<\/td>\n\u68c0\u67e5try-catch-finally\u5d4c\u5957\u5c42\u6570<\/td>\n<\/tr>\n
ReturnCount<\/td>\nmax<\/td>\n2<\/td>\n\u4e00\u4e2a\u65b9\u6cd5\u6700\u591a\u6709return\u7684\u6570\u91cf<\/td>\n<\/tr>\n
CyclomaticComplexity<\/td>\nmax<\/td>\n10<\/td>\n\u65b9\u6cd5\u5708\u590d\u6742\u5ea6<\/td>\n<\/tr>\n
MagicNumber<\/td>\n<\/td>\n<\/td>\n\u68c0\u67e5\u9b54\u6cd5\u6570\u5b57\uff0c\u672a\u88ab\u5b9a\u4e49\u4e3a\u5e38\u91cf\u7684\u6570\u503c<\/td>\n<\/tr>\n
…<\/td>\n<\/td>\n<\/td>\nhttps:\/\/checkstyle.org\/checks.html<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u4e09\u3001\u6700\u4f73\u5b9e\u8df5\uff1a\u5982\u4f55\u5c06\u89c4\u8303\u878d\u5165\u65e5\u5e38\u5f00\u53d1<\/strong><\/h2>\n

3.1 code style\u914d\u7f6e&\u4f7f\u7528<\/h3>\n

a. IDEA\u914d\u7f6ecode style<\/h4>\n

\u5728 IntelliJ IDEA\u4e0b\uff0c\u4f7f\u7528intellij-java-jd-style.xml<\/code>\u8fdb\u884c\u4ee3\u7801\u683c\u5f0f\u5316\u4e4b\u524d\uff0c\u9700\u8981\u5148\u8fdb\u884c\u914d\u7f6e\u3002<\/p>\n

\u8bbe\u7f6e\u914d\u7f6e\u6587\u4ef6\uff0c\u8def\u5f84\uff1aIntelliJ IDEA<\/code>\u2192Preference<\/code>\u2192Editor<\/code>\u2192Code Style<\/code>\uff0c\u53c2\u8003\u4e0b\u56fe\uff1a<\/p>\n

\u5bfc\u5165\u5b9a\u5236\u7684code style\u6587\u4ef6\uff1aintellij-java-jd-style.xml<\/a><\/p>\n

\"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n<\/p>\n

\u547d\u540dScheme\uff0c\u5982\u56fe\u4e2dJD-Style\uff0c\u5e76\u542f\u7528\u8be5\u4ee3\u7801\u6837\u5f0f\u89c4\u8303<\/p>\n

\"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n

b. IDEA\u4f7f\u7528code style<\/h4>\n

\u5b8c\u6210\u4e0a\u8ff0\u914d\u7f6e\u540e\uff0c\u5728Mac\u73af\u5883\u7684IntelliJ IDEA\u4e2d\uff0c\u53ef\u4ee5\u5bf9\u9009\u4e2d\u7684\u4ee3\u7801\u683c\u5f0f\u5316\uff08\u5feb\u6377\u952e\uff1aOption+Command+L\uff09\u6216\u8005\u5bf9\u9009\u4e2d\u7684\u6587\u4ef6\u683c\u5f0f\u5316\uff08\u5feb\u6377\u952e\uff1aShift+Option+Command+L\uff09<\/p>\n

\"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n

3.2 check style\u914d\u7f6e&\u4f7f\u7528<\/h3>\n

check style\u7684\u914d\u7f6e\u548c\u4f7f\u7528\u6709\u4e24\u79cd\u4e3b\u8981\u65b9\u5f0f\uff1a<\/p>\n

    \n
  1. \u5728\u5f00\u53d1\u73af\u5883IDE\u4e2d\uff0c\u5f00\u53d1\u8005\u914d\u7f6e\u63d2\u4ef6\u540e\uff0c\u53ef\u89e6\u53d1\u4ee3\u7801\u6837\u5f0f\u89c4\u8303\u7684\u68c0\u67e5\uff0c\u6839\u636e\u63d0\u793a\u9879\u8fdb\u884c\u4ee3\u7801\u4fee\u6539\uff1b<\/li>\n<\/ol>\n

    2.\u5728maven\u9879\u76ee\u4e2d\uff0c\u914d\u7f6echeckstyle\u63d2\u4ef6\uff0c\u53ef\u7528\u547d\u4ee4\u884c\u89e6\u53d1\u4ee3\u7801\u6837\u5f0f\u89c4\u8303\u7684\u68c0\u67e5\uff0c\u96c6\u6210\u5230CI (Continuous Integration)\u7684\u81ea\u52a8\u5316\u6d41\u6c34\u7ebf\u4e2d\uff1b<\/p>\n

    a. IDEA\u914d\u7f6eCheckStyle\u63d2\u4ef6<\/h4>\n

    \u5728 IntelliJ IDEA\u4e0b\uff0c\u5b89\u88c5Plugin\uff0c\u8def\u5f84\uff1aIntelliJ IDEA<\/code>\u2192Preference<\/code>\u2192Plugins<\/code>\uff0c\u53c2\u8003\u4e0b\u56fe\uff1a<\/p>\n

    \"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n

    \u4e0b\u8f7d\u914d\u7f6e\u6587\u4ef6checkstyle.xml<\/a>\uff0c\u914d\u7f6eCheckStyle-IDEA\u63d2\u4ef6\uff0c\u8def\u5f84\uff1aIntelliJ IDEA<\/code>\u2192Preference<\/code>\u2192Tools<\/code>\u2192Checkstyle<\/code>\uff0c\u589e\u52a0\u81ea\u5b9a\u4e49\u914d\u7f6e\u6587\u4ef6\u5e76\u547d\u540d\uff0c\u53c2\u8003\u4e0b\u56fe\uff1a<\/p>\n

    \"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n

    b. IDEA\u4f7f\u7528CheckStyle\u63d2\u4ef6<\/h4>\n

    \u5b89\u88c5\u914d\u7f6eCheckStyle\u63d2\u4ef6\u540e\uff0c\u5de5\u5177\u7a97\u53e3\u589e\u52a0\u4e86CheckStyle Tab\uff0c\u5728CheckStyle\u7a97\u53e3\u8fdb\u884ccheck\uff0c\u53ef\u4ee5\u9009\u62e9\uff1a<\/p>\n

    \u2022Check Current File<\/code><\/p>\n

    \u2022Check Module<\/code><\/p>\n

    \u2022Check Project<\/code><\/p>\n

    \"\u5728\u8fd9\u91cc\u63d2\u5165\u56fe\u7247\u63cf\u8ff0\"<\/p>\n

    c. maven\u914d\u7f6eCheckStyle\u63d2\u4ef6<\/h4>\n

    \u53c2\u8003Checkstyle maven\u63d2\u4ef6\u7684\u5b98\u65b9\u914d\u7f6e\u6848\u4f8b\uff1a\u591a\u6a21\u5757\u9879\u76ee\u914d\u7f6e<\/a>\uff0c\u901a\u5e38\u6211\u4eec\u5728\u9879\u76ee\u4e2d\u65b0\u5efabuild-tools\u6a21\u5757\uff0c\u5c06checkstyle.xml\u7b49\u914d\u7f6e\u6587\u4ef6\u653e\u5728\u8fd9\u4e2a\u6a21\u5757\u7684resources\u76ee\u5f55\u4e0b\u3002<\/p>\n

    project-name\n| -- pom.xml\n| -- build-tools\n| | -- pom.xml\n| | -- src\n| | | -- main\n| | | -- resources\n| | | -- checkstyle.xml\n| | | -- checkstyle-suppressions.xml\n| -- core\n| -- gui\n| -- other-module\n<\/code><\/pre>\n
    build-tools\u6a21\u5757\u7684pom.xml\u4f7f\u7528IDEA\u81ea\u52a8\u751f\u6210\u7684\u914d\u7f6e\u6587\u4ef6\uff0c\u7c7b\u4f3c\uff1a<\/p>\n
    <?xml version="1.0" encoding="UTF-8"?>\n<project>\n    <parent>\n        <artifactId>project-name<\/artifactId>\n        <groupId>com.jd.project-name<\/groupId>\n        <version>1.0.0<\/version>\n    <\/parent>\n\n    <modelVersion>4.0.0<\/modelVersion>\n    <artifactId>build-tools<\/artifactId>\n<\/project>\n<\/code><\/pre>\n
    \u914d\u7f6e\u6587\u4ef6checkstyle.xml\u3001checkstyle-suppressions.xml\u53ef\u4ee5\u4ececoding\u4e2d\u4e0b\u8f7dhttp:\/\/xingyun.jd.com\/codingRoot\/liuzhongwei18\/styleguide\/blo…<\/a>\u3002<\/p>\n
    \u7236\u9879\u76ee\u7684pom.xml\u4e2d\uff0c\u589e\u52a0\u5982\u4e0b\u914d\u7f6e\uff1a<\/p>\n
    <project>\n    ...\n    <modules>\n        ...\n        <module>build-tools<\/module>\n    <\/modules>\n\n    <properties>\n        ...\n        <maven.checkstyle.version>3.6.0<\/maven.checkstyle.version>\n    <\/properties>\n\n    <build>\n        <pluginManagement>\n            <plugins>\n                <plugin>\n                    <!-- Approach followed here is roughly the same as mentioned here:\n                         https:\/\/maven.apache.org\/plugins\/maven-checkstyle-plugin\/examples\/multi-module-config.html\n                    -->\n                    <groupId>org.apache.maven.plugins<\/groupId>\n                    <artifactId>maven-checkstyle-plugin<\/artifactId>\n                    <version>${maven.checkstyle.version}<\/version>\n                    <configuration>\n                        <configLocation>build-tools\/src\/main\/resources\/checkstyle.xml<\/configLocation>\n                        <includeTestSourceDirectory>true<\/includeTestSourceDirectory>\n                        <outputFile>checkstyle-report.xml<\/outputFile>\n                        <consoleOutput>false<\/consoleOutput>\n                        <failOnViolation>true<\/failOnViolation>\n                        <excludes>target\/**<\/excludes>\n                    <\/configuration>\n                    <executions>\n                        <execution>\n                            <id>checkstyle<\/id>\n                            <phase>validate<\/phase>\n                            <goals>\n                                <goal>check<\/goal>\n                            <\/goals>\n                        <\/execution>\n                    <\/executions>\n                <\/plugin>\n            <\/plugins>\n        <\/pluginManagement>\n        <plugins>\n            <plugin>\n                <groupId>org.apache.maven.plugins<\/groupId>\n                <artifactId>maven-checkstyle-plugin<\/artifactId>\n            <\/plugin>\n        <\/plugins>\n    <\/build>\n    <reporting>\n        <plugins>\n            <plugin>\n                <groupId>org.apache.maven.plugins<\/groupId>\n                <artifactId>maven-checkstyle-plugin<\/artifactId>\n                <reportSets>\n                    <reportSet>\n                        <reports>\n                            <report>checkstyle<\/report>\n                        <\/reports>\n                    <\/reportSet>\n                <\/reportSets>\n            <\/plugin>\n        <\/plugins>\n    <\/reporting>\n\n<\/project>\n<\/code><\/pre>\n
    maven-checkstyle-plugin\u7684\u914d\u7f6e<configuration>\u53c2\u6570\u5177\u4f53\u53ef\u53c2\u89c1checkstyle:check<\/a>\u7684\u53c2\u6570\u8bf4\u660e\u3002<\/p>\n
    \u8fd9\u91cc\u5bf9\u51e0\u9879\u914d\u7f6e\u8fdb\u884c\u8bf4\u660e\uff1a<\/p>\n
    \u2022plugins>plugin>executions>execution<\/p>\n
    \u25e6id\u53ef\u4ee5\u81ea\u884c\u51b3\u5b9a\uff0c\u8fd9\u91cc\u9009\u62e9”checkstyle”\uff1b<\/p>\n
    \u25e6phase\u662f\u7ed1\u5b9a\u5230maven lifecycle\u7684\u54ea\u4e2a\u6267\u884c\u9636\u6bb5\uff0c\u8fd9\u91cc\u7ed1\u5b9a\u5230”validate<\/a>“\u4e0a\uff0c\u5373\u6267\u884cmaven validate\u7684\u65f6\u5019\u4f1a\u6267\u884c\u8be5plugin\u4efb\u52a1\uff1b\u9009\u62e9validate\u9636\u6bb5\u53ef\u4ee5\u4fdd\u969ccheckstyle:check\u5728\u4ee3\u7801\u7f16\u8bd1\u4e4b\u524d\u6267\u884c\uff0c\u5982\u679ccheckstyle\u68c0\u67e5\u51fa\u8fdd\u53cd\u6837\u5f0f\u89c4\u8303\u7684\u95ee\u9898\uff0c\u5728\u4ee3\u7801\u7f16\u8bd1\u4e4b\u524d\u5c31\u4f1a\u62a5\u544a\u51fa\u6765\uff1b<\/p>\n
    \u25e6goals>goal\u662f\u53ea\u7ed1\u5b9a\u6267\u884cplugin\u7684\u54ea\u4e2a\u4efb\u52a1\uff0c\u8fd9\u91cc\u7ed1\u5b9a\u7684\u662f”check”\uff1b<\/p>\n
    \u2022plugins>plugin>configuration>failOnViolation<\/p>\n
    \u25e6\u68c0\u67e5\u5230\u8fdd\u53cd\u6837\u5f0f\u89c4\u8303\u7684\u95ee\u9898\uff0c\u6253\u5370\u51fa\u6765\uff0c\u6253\u5370\u7684\u95ee\u9898\u7ea7\u522b\u6839\u636echeckstyle.xml<\/a>\u4e2d\u914d\u7f6e\u7684severity\u786e\u5b9a\uff1b<\/p>\n
    \u25e6\u5c06severity\u7ea7\u522b\u914d\u7f6e\u4e3aerror\uff0c\u5e76\u5c06failOnViolation\u8bbe\u4e3atrue\uff0c\u68c0\u67e5\u5230\u8fdd\u53cd\u6837\u5f0f\u89c4\u8303\u7684\u95ee\u9898\u65f6\uff0c\u4f1a\u505c\u6b62maven\u547d\u4ee4\u7ee7\u7eed\u6267\u884c\uff1b<\/p>\n
    \u6ce8\u610f\uff1afailOnViolation<\/a>\u4e0efailOnError<\/a>\u914d\u7f6e\u9879\u7684\u533a\u522b\uff0cfailOnError\u5728\u68c0\u67e5\u5230\u95ee\u9898\u65f6\u7acb\u5373\u505c\u6b62\u6267\u884c\uff0cfailOnViolation\u5728\u68c0\u67e5\u5230\u95ee\u9898\u65f6\u8f93\u51fa\u68c0\u67e5\u65e5\u5fd7\u518d\u505c\u6b62\u6267\u884c\u3002<\/p>\n
    \u6309\u7167\u4e0a\u8ff0\u914d\u7f6e\uff0c\u53ef\u8fbe\u5230\u5728mvn\u7f16\u8bd1\u4ee3\u7801\u524d\u5f3a\u5236\u68c0\u67e5\u4ee3\u7801\u6837\u5f0f\u89c4\u8303\uff0c\u53d1\u73b0\u8fdd\u53cd\u89c4\u8303\u7684\u95ee\u9898\uff0c\u4e0d\u4f1a\u7ee7\u7eedjava\u7684\u7f16\u8bd1\u3001\u6253\u5305\u3002<\/p>\n
    d. maven\u4f7f\u7528CheckStyle\u63d2\u4ef6<\/h4>\n
    \u8fd0\u884cmvn package\u5373\u53ef\u6b63\u5e38\u6253\u5305\u3002<\/p>\n
    \u4e5f\u53ef\u4ee5\u5355\u72ec\u6267\u884c\u547d\u4ee4\uff1a<\/p>\n
    mvn checkstyle:check\n<\/code><\/pre>\n
    \u6ce8\u610f\uff1a\u4e3a\u4e86\u5b9e\u73b0\u81ea\u52a8\u5316\u4ee3\u7801\u6837\u5f0f\u89c4\u8303\u68c0\u67e5\uff0c\u53ef\u4ee5\u4e3a\u9879\u76ee\u914d\u7f6e\u884c\u4e91\u6d41\u6c34\u7ebf\u4efb\u52a1\uff0c\u8bbe\u7f6e\u4ee3\u7801\u8bc4\u5ba1\u7684\u81ea\u52a8\u5316\u68c0\u67e5<\/a>\uff1a\u6307\u5b9a\u6d41\u6c34\u7ebf\u505a\u4e3a\u5361\u70b9\uff0c\u6307\u5b9a\u4e3a\u5361\u70b9\u7684\u6d41\u6c34\u7ebf\u9700\u8fd0\u884c\u6210\u529f\u540eMR\u624d\u5141\u8bb8\u5408\u5e76\u3002<\/p>\n<\/p>\n
    \u56db\u3001\u7ed3\u8bed\uff1a\u4ee3\u7801\u89c4\u8303-\u56e2\u961f\u534f\u4f5c\u7684\u6865\u6881<\/strong><\/h2>\n
    \u6700\u540e\uff0c\u6211\u4eec\u603b\u7ed3\u4e0bJava\u6837\u5f0f\u89c4\u8303\u5bf9\u4e8e\u56e2\u961f\u534f\u4f5c\u7684\u91cd\u8981\u6027\uff0c\u9f13\u52b1\u6bcf\u4f4d\u5f00\u53d1\u8005\u5c06\u8fd9\u4e9b\u89c4\u8303\u5185\u5316\u4e3a\u81ea\u5df1\u7684\u7f16\u7801\u4e60\u60ef\u3002\u56e0\u4e3a\u4ee3\u7801\u89c4\u8303\u4e0d\u4ec5\u662f\u4e2a\u4eba\u6280\u827a\u7684\u4f53\u73b0\uff0c\u66f4\u662f\u56e2\u961f\u534f\u4f5c\u548c\u9879\u76ee\u6210\u529f\u7684\u57fa\u77f3\u3002<\/p>\n
    \u901a\u8fc7\u9605\u8bfb\u672c\u6587\uff0c\u4f60\u5c06\u4e0d\u4ec5\u4e86\u89e3\u5230Java\u6837\u5f0f\u89c4\u8303\u7684\u91cd\u8981\u6027\uff0c\u8fd8\u5c06\u638c\u63e1\u5982\u4f55\u5c06\u8fd9\u4e9b\u89c4\u8303\u5e94\u7528\u5230\u5b9e\u9645\u5f00\u53d1\u4e2d\uff0c\u8ba9\u4f60\u7684\u4ee3\u7801\u53d8\u5f97\u66f4\u52a0\u4f18\u96c5\u548c\u5f3a\u5927\u3002\u8ba9\u6211\u4eec\u4e00\u8d77\u8ffd\u6c42\u7f16\u7801\u7684\u827a\u672f\uff0c\u7528\u89c4\u8303\u7684\u4ee3\u7801\u70b9\u4eae\u7f16\u7a0b\u7684\u4e16\u754c\u3002<\/p>\n<\/p>\n
    \u53c2\u8003<\/h2>\n
    \u2022\u4eac\u4e1cJAVA\u4ee3\u7801\u89c4\u8303-V1.0.pdf<\/a><\/p>\n
    \u2022JD\u7f16\u7801\u89c4\u8303\uff1ahttps:\/\/doc.jd.com\/base\/eos-doc\/system-rule\/JD%E7%BC%96%E7%A0…<\/a><\/p>\n
    \u2022Jetbrains Java code style: https:\/\/www.jetbrains.com\/help\/idea\/code-style-java.html<\/a><\/p>\n
    \u2022checkstyle\u5b98\u7f51\uff1ahttps:\/\/checkstyle.org\/index.html<\/a><\/p>\n
    \u2022checkstyle\u53d1\u5e03\uff1ahttps:\/\/github.com\/checkstyle\/checkstyle\/releases\/<\/a><\/p>\n
    \u2022Apache Maven Checkstyle Plugin: https:\/\/maven.apache.org\/plugins\/maven-checkstyle-plugin\/usag…<\/a><\/p>\n
    https:\/\/segmentfault.com\/a\/1190000045509608<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
    \u4f5c\u8005\uff1a\u4eac\u4e1c\u96f6\u552e \u5218\u4ef2\u4f1f \u5728\u8f6f\u4ef6\u5f00\u53d1\u7684\u4e16\u754c\u91cc\uff0c\u4ee3\u7801\u4e0d\u4ec5\u662f\u7a0b\u5e8f\u7684\u57fa\u77f3\uff0c\u66f4\u662f\u7a0b\u5e8f\u5458\u4ea4\u6d41\u7684\u901a\u7528\u8bed\u8a00\u3002\u800cJava\uff0c\u4f5c\u4e3a\u4e00 […]<\/p>\n","protected":false},"author":7,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[4],"tags":[],"class_list":["post-10020422","post","type-post","status-publish","format-standard","hentry","category-share"],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/itmax.cn\/index.php?rest_route=\/wp\/v2\/posts\/10020422","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/itmax.cn\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/itmax.cn\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/itmax.cn\/index.php?rest_route=\/wp\/v2\/users\/7"}],"replies":[{"embeddable":true,"href":"https:\/\/itmax.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=10020422"}],"version-history":[{"count":0,"href":"https:\/\/itmax.cn\/index.php?rest_route=\/wp\/v2\/posts\/10020422\/revisions"}],"wp:attachment":[{"href":"https:\/\/itmax.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=10020422"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/itmax.cn\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=10020422"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/itmax.cn\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=10020422"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}