java书写规范,java的正确写法是什么 收藏 0

2025年Java开发者必读：编写文档的9种姿势

在2025年，Java代码的文档化对于保持项目的可维护性和减少开发团队之间的摩擦至关重要。随着代码库复杂性的增加，文档化确保了知识的共享、新成员的快速入职以及错误的减少。

没有清晰、最新的文档，开发者会浪费大量时间去理解不熟悉的代码，导致项目延迟和成本高昂的错误。文档化作为开发者的路线图，帮助他们理解代码的设计、结构和目的。

• 重构遗留代码：在处理遗留系统时，适当的文档帮助开发者导航过时或复杂的代码库。通过清晰的Javadoc或其他形式的文档，开发者可以安全地重构，理解依赖关系和旧代码的预期功能。这减少了在现代化过程中破坏关键功能的风险。
• 现代化应用程序：在应用程序现代化的过程中，文档化至关重要。它帮助开发者识别系统中哪些部分适合现代化，并确保在过渡期间保持兼容性。
• 维护微服务：微服务架构由于服务的分布式特性和不同组件之间无缝通信的需求而变得复杂。良好的文档化帮助团队快速理解API、服务交互和数据流，减少停机时间并提高服务更新的可靠性。
• 新开发者入职：良好的文档化加速了新成员的入职过程，使他们能够更快地理解代码库。新开发者可以通过文档快速了解不同模块的交互和关键功能的位置，而不必依赖于部落知识或过多的会议。
• 跨团队协作：在大型组织中，多个团队经常在项目的不同部分工作。清晰的Java文档确保了团队之间的连贯性，使协作更容易，并防止对功能或设计选择的误解。

文档工具应贯穿整个开发过程。在开发初期，高层次的架构和组件描述是必要的。在开发过程中，自动从注释生成文档的工具（如Javadoc）非常有用。对于API密集的项目，提供交互式文档的工具很有价值，而内部项目则受益于易于导航和组织的文档。

• 保持文档与代码同步：随着代码库的演变，保持文档的更新可能很繁琐。自动同步代码的工具可以帮助防止不一致。
• 自动生成高质量文档：并非所有自动生成的文档都有用。它们往往缺乏上下文，使得难以理解类或方法的目的。高质量的自动生成文档需要超越方法签名，提供相关上下文。
• 理解上下文、模块和依赖：在大型项目中，不仅仅是文档化单个组件，还要理解它们如何交互。映射模块依赖关系和流程的工具帮助开发者看到更大的图景。
• 平衡文档量：过度文档化会使代码库变得混乱，而文档不足则留下太多未解答的问题。找到平衡点是有效文档化的关键。

在选择文档工具时，考虑以下因素：

• 项目规模和复杂度：大规模项目可能需要更强大的解决方案，支持交叉引用和依赖关系映射。
• 文档类型需求：你是构建面向公众的API还是内部项目文档？这将决定所需的交互性和用户友好性。
• 团队工作流程：工具与现有CI/CD管道或版本控制系统集成的无缝程度如何？最好的工具是那些自然融入团队工作流程且设置最少的工具。
• 维护便捷性：选择简化文档更新的工具。自动化或直接从代码生成文档的工具可以显著减少维护开销。

Swimm 是一个尖端的平台，用于文档化Java代码（以及其他编程语言），旨在处理大型、复杂甚至遗留代码库的挑战。与传统文档工具不同，Swimm使用上下文AI自动创建和维护与源代码直接关联的文档。这确保了Java代码库始终伴随着最新的、相关的文档，而无需手动干预。

主要功能和优势：

• 自动生成文档：Swimm通过分析代码库自动生成Java项目的文档。其AI驱动的引擎支持现代框架和遗留系统，确保Java代码库的每个组件都被覆盖。这一功能简化了入职流程，帮助团队轻松导航复杂的Java应用程序。
• 实时更新：Swimm擅长保持文档与代码更改同步。当Java开发者推送更新或重构代码时，Swimm会相应调整文档，确保其永远不会过时。这一功能消除了代码文档中最常见的问题——与实际代码不一致。
• 无缝集成：Swimm无缝集成到常见的Java开发工作流程中，包括GitHub、GitLab和流行的CI/CD管道。这种紧密集成允许Java开发者生成和更新文档作为现有流程的一部分，确保文档随着代码的发展而演变。
• 上下文理解：Swimm允许开发者在Java应用程序中映射模块、依赖关系和架构。这种上下文理解在处理复杂系统时特别有益，使开发者能够看到Java代码库的不同部分如何交互，加快开发并减少错误。

Javadoc是Java中用于直接从代码注释生成HTML文档的标准工具。它将/**开头的注释转换为类、方法、参数和异常的详细文档。关键标签包括@param用于方法参数，@return用于返回值，@throws用于异常。内联标签如{@link}允许在文档中进行交叉引用。

以下是一个如何在Java方法中使用Javadoc的示例：

最佳实践：

• 从方法的简短摘要开始，然后详细解释参数和返回值。
• 避免过度注释或详细说明实现细节。相反，重点描述代码的行为，从用户的角度出发。

例如

Doxygen是一个强大的开源文档工具，广泛用于从注释代码生成全面的文档，包括Java项目。它擅长生成在线和离线文档，支持多种格式如HTML、PDF和LaTeX。Doxygen支持多种编程语言，使其特别适用于跨语言项目或在Java之外需要文档的项目。

什么是Doxygen？

Doxygen通过解析源代码中的特殊格式注释来生成结构化文档。它支持多种语言，包括Java、C++、Python等。对于Java，它类似于Javadoc，但提供了更多的灵活性，如支持图表和多种输出格式。它甚至可以在代码元素之间进行交叉引用，使导航大型代码库更容易。

如何使用Doxygen

要使用Doxygen文档化Java项目，首先需要安装它并创建一个配置文件：

这将生成一个配置文件，您可以根据需要进行自定义。配置完成后，您可以使用以下命令生成文档：

支持多种标签，如@param用于参数，@return用于返回值，@throws用于异常。这些标签功能类似于Javadoc，但具有额外的灵活性，如集成图表和视觉辅助。何时使用Doxygen

Doxygen特别适用于多语言项目或需要比Javadoc提供更多高级功能的Java项目。它适用于生成需要共享多种格式（HTML、PDF等）的文档，或需要代码结构可视化表示的项目，如图表。

最佳实践：

• 将注释直接放在要文档化的类、方法或字段上方。
• 使用Doxygen的扩展功能，如图表，在文档化复杂系统时，视觉表示有助于理解类和方法之间的关系。
• 配置EXTRACT_ALL以确保即使未文档化的元素也包含在文档中，这在项目早期阶段很有用。
• 使用CI/CD工具或预提交钩子自动化文档生成过程，以确保文档与代码更改同步。

例如

Asciidoctor是一个流行的工具链，用于处理AsciiDoc，一种用于编写技术文档的纯文本格式。Asciidoctor将AsciiDoc文档转换为多种格式，如HTML、PDF、DocBook和EPUB。它是一个强大的解决方案，适用于Java项目，因为它简化了编写和发布丰富、结构化文档的过程。

什么是Asciidoctor？

Asciidoctor处理AsciiDoc，一种专注于写作简便性和可读性的轻量级标记语言。它允许您从简单的文本文件生成干净、专业的文档。Asciidoctor带有Java绑定，称为AsciidoctorJ，允许与Java项目无缝集成。这使得Java开发者可以直接从Java应用程序将AsciiDoc文件转换为HTML和PDF等格式。

如何使用Asciidoctor

要在Java项目中使用Asciidoctor，首先需要将其添加到依赖项中。如果您使用Gradle，请在build.gradle中包含以下内容：

AsciidoctorJ提供了一个API，用于从文件或字符串转换AsciiDoc内容。以下是一个使用AsciidoctorJ API将字符串转换为HTML的示例：

此代码将一个简单的AsciiDoc字符串转换为HTML，您可以通过设置不同的选项（如后端类型）来自定义转换。要转换文件，请使用convertFile方法。何时使用Asciidoctor

Asciidoctor适用于生成结构化文档的Java项目，其中可维护性和格式灵活性是关键。它适用于需要协作处理大型文档项目的团队，或需要多种格式一致输出的项目。通过自动化文档生成作为构建过程的一部分，Asciidoctor在CI/CD环境中特别有用。

最佳实践：

• 利用AsciiDoc功能：使用AsciiDoc的强大语法来包含图表、表格和其他丰富内容。例如，使用include指令直接从源文件引用代码片段，确保文档与代码保持同步。
• 自动化生成：使用Maven或Gradle插件自动化文档生成过程，作为构建过程的一部分。这确保了文档始终与最新更改同步。
• 使用扩展：Asciidoctor支持扩展，如PlantUML，用于直接从文本描述生成图表。您可以通过配置AsciidoctorJ在项目中包含这些扩展。

Slate是一个广泛使用的开源工具，用于使用Markdown创建响应式、视觉上吸引人的API文档。其简单性和灵活性使其在开发者中广受欢迎，他们希望构建用户友好的、交互式的API文档。使用Markdown作为核心，Slate提供了一种以易于阅读的格式构建文档的方式，消除了复杂HTML或CSS的需求。

什么是Slate？

Slate是一个静态站点生成器，将Markdown文件转换为时尚、交互式的文档网站。受Stripe和PayPal等公司API文档的启发，它专注于清晰和易用性。生成的站点的左侧通常包含API描述，右侧显示相应的代码示例。用户可以通过切换不同编程语言的标签来查看相同的API端点，这得益于多代码示例的标签。

如何使用Slate要使用Slate创建API文档，首先编写Markdown内容。您可以通过标记它们各自的语言头（如shell、ruby或php）添加代码示例。Slate自动为100多种语言高亮语法。以下是一个用于GET API端点的Markdown片段示例：

这将生成静态HTML文档，您可以将其托管在任何服务器上，甚至直接托管在GitHub Pages上。

何时使用Slate

Slate最适合用于文档化RESTful API，特别是当您需要提供多种编程语言的示例时。它适用于希望拥有干净、单页文档站点的团队，用户可以在其中查看API参考信息并测试代码片段。

最佳实践：

• 使用include组织内容：为API的不同部分使用单独的Markdown文件，并在主文件中包含它们。这使得管理大型文档更容易。
• 多语言支持：利用Slate在语言之间切换的能力，提供Shell、Python、Ruby等流行语言的示例。
• 交互式示例：包含示例API请求和响应，以便开发者快速理解预期行为。
• 版本控制：使用GitHub维护文档的版本控制，允许开发者贡献更新或修正。

DocFX是一个强大且灵活的文档生成工具，支持多种语言，包括Java。由Microsoft开发，它擅长从源代码和Markdown文件生成静态网站。虽然最初是为.NET构建的，但它同样适用于Java项目，特别是当您需要全面的、多格式的文档时。

什么是DocFX？

DocFX通过解析代码注释和Markdown文件生成文档。它支持多种编程语言，并提供可定制的模板，使其成为需要品牌化或企业级文档的团队的绝佳选择。DocFX可以输出HTML、PDF和其他格式，为您提供了如何分发文档的灵活性。

如何使用DocFX您可以通过创建一个配置文件（docfx.json）将DocFX集成到Java项目中，该文件指定了源文件、元数据和输出格式。对于Java代码，您可以使用Markdown添加详细的解释和示例，以及自动生成的API文档。配置完成后，使用以下命令生成文档：

此命令处理Markdown和源代码文件，生成一个静态网站，您可以将其托管在任何地方。

何时使用DocFX

DocFX适用于需要API参考文档和用户指南的团队。它在多语言环境中工作良好，不同团队可能使用Java、.NET或其他技术。凭借其丰富的定制选项，DocFX允许您在所有文档中保持一致的外观，这对于需要专业文档的大型项目或企业特别有用。

最佳实践：

• 结合代码注释和Markdown：利用DocFX的能力将API文档与详细的指南和示例结合，提供全面的文档体验。
• 自定义模板：利用DocFX的模板引擎创建品牌化的外观和感觉。这对于有特定设计指南的大型团队特别有用。
• 版本控制：将DocFX集成到版本控制系统（如GitHub或Azure DevOps）中，以维护一致的、版本化的文档，随着代码库的演变而更新。

Java中的注解（如@Override、@Deprecated和@NonNull）是使代码更具自解释性的关键工具。它们通过将元数据直接嵌入源代码中，提高了代码的可读性和可维护性。注解为编译器和工具提供指令，允许生成更健壮和无错误的代码。

什么是Java注解？

注解是Java中的一种元数据形式，提供有关代码的额外信息，但不影响程序的行为。它们用于向编译器、运行时环境或代码分析工具传达信息。常见的内置注解包括@Override，确保方法覆盖其父类中的一个方法，以及@Deprecated，标记不应再使用的元素。例如，@Override用于确保您正确覆盖父类中的方法。如果有拼写错误或方法签名不匹配，编译器将引发错误：

在这个示例中，Dog类覆盖了Animal类的makeSound方法。如果您忘记@Override注解，Java仍然允许该方法，但不会捕捉到方法签名错误等错误。

如何使用Java注解

注解很简单，通常位于类、方法或变量声明之前。在上面的示例中，@Override确保方法覆盖父类中的一个方法。@Deprecated注解用于标记不应再使用的元素。这在API开发中很有用，旧方法被新方法取代但仍需保持向后兼容性：

当您尝试使用oldMethod时，编译器将生成警告，敦促您迁移到新方法。同样，@NonNull帮助防止空指针异常，指示字段、参数或返回值不能为空。如果违反注解，许多IDE将发出警告，运行时环境可能会抛出异常：

何时使用Java注解

Java注解最好用于向编译器和未来开发者传达代码元素的重要细节。注解如@Override和@NonNull对于减少运行时错误和提高代码正确性至关重要。在过渡旧方法但仍需保持向后兼容性时使用@Deprecated。在Spring和Hibernate等框架中，注解如@Autowired和@Entity广泛用于处理依赖注入和对象关系映射。

最佳实践：

• 为每个方法覆盖使用@Override：这确保方法覆盖正确完成，防止常见错误如方法签名拼写错误。
• 始终将@Deprecated与文档配对：使用Javadoc的@deprecated标签和@Deprecated注解解释为什么方法被弃用并建议替代方案。
• 在适用的地方使用@NonNull：通过在方法参数和返回值上应用@NonNull注解，避免空指针异常，特别是在处理用户输入或数据处理的方法中。
• 保持一致性：确保在整个代码库中一致应用注解。这有助于IDE和静态分析工具生成更好的见解和警告。

Sphinx是一个文档生成器，传统上用于Python项目，但也在Java社区中获得了关注。通过使用reStructuredText（reST）作为其标记语言，Sphinx提供了生成多种格式（如HTML、LaTeX和PDF）的全面文档的灵活性。虽然Sphinx原生是Python工具，但JavaSphinx扩展将其与Java项目无缝集成，允许Java开发者以类似于使用Javadoc的方式生成文档。

什么是Sphinx？Sphinx将用reStructuredText（reST）编写的纯文本文件转换为各种格式的干净、结构化文档。其对Java项目的支持通过JavaSphinx插件实现，该插件将Javadoc注释转换为reST。这允许Java开发者从现有代码注释生成Sphinx风格的文档，增强与非Java组件的兼容性。

如何使用Sphinx

要在Java项目中使用Sphinx，您需要集成JavaSphinx插件。您可以通过Python的包管理器安装JavaSphinx，并在Sphinx项目中进行配置。首先，在Sphinx的conf.py文件中添加JavaSphinx：

配置完成后，您可以使用javasphinx-apidoc工具从Javadoc风格的注释生成文档，该工具自动将Java代码转换为reST。例如：javasphinx-apidoc -o docs/source src/ 这将生成.rst文件，Sphinx可以使用这些文件创建HTML或其他文档格式。

何时使用Sphinx

Sphinx是团队需要跨多种语言统一文档工具的绝佳选择。它特别适用于Java项目与非Java组件集成，或需要生成丰富文档的项目，这些文档超出了标准Javadoc输出。此外，Sphinx允许轻松定制，如图表使用PlantUML或嵌入笔记本使用

Jupyter最佳实践：

• 利用reStructuredText的清晰性：使用reST编写清晰、结构化的文档。使用标题、列表和链接提供上下文。
• 结合Javadoc和Sphinx：使用JavaSphinx自动将Javadoc注释转换为reST，允许您保持一致性，同时受益于Sphinx的丰富功能。
• 自动化构建过程：将Sphinx集成到构建过程中，使用工具如Gradle或Maven，以确保文档始终与代码更改同步。
• 使用视觉效果：通过使用PlantUML创建图表来扩展文档，增强文档的可读性和解释力。

MkDocs是一个快速且简单的静态站点生成器，专门用于构建项目文档。它广泛用于将Markdown文件转换为功能齐全的静态网站，使其成为喜欢使用Markdown编写文档的Java开发者的绝佳工具。MkDocs特别适用于内部Java项目文档或快速设置用户友好的文档站点。

什么是MkDocs？

MkDocs将Markdown文件转换为静态HTML网站，可以托管在GitHub Pages或任何静态Web服务器上。它使用一个YAML配置文件（mkdocs.yml）来定义站点结构、主题和设置。文档使用简单的Markdown编写，这使得它易于管理和访问，特别是对于熟悉Markdown语法的开发者。

如何使用MkDocs

要开始使用MkDocs，您需要通过Python的包管理器安装它：

安装完成后，您可以使用以下命令创建一个新的文档项目：

MkDocs带有一个实时预览服务器，允许您在编写文档时查看更改。使用以下命令启动服务器：

核心配置在mkdocs.yml文件中进行，您可以在其中定义文档的结构、选择主题和设置插件。例如，您可以像这样组织导航并添加Markdown文件：

一旦您的文档准备就绪，您可以将其构建为静态HTML：

这将生成一个包含所有HTML文件的site文件夹，准备部署到GitHub Pages、Amazon S3或任何静态托管提供商。

何时使用MkDocs

MkDocs非常适合内部或外部Java项目文档，特别是如果您的团队熟悉Markdown。它适用于维护轻量级、易于阅读的文档，可以快速部署。此外，它具有高度的可扩展性，带有插件和主题，允许您添加搜索功能、自定义主题，甚至将其与版本控制集成以方便协作。

最佳实践：

• 组织内容：使用mkdocs.yml文件中的导航设置保持文档结构简单且逻辑清晰。这确保读者可以轻松导航站点的不同部分。
• 使用插件：利用MkDocs的许多插件，如搜索插件或PDF导出插件，以增强文档的功能。
• 自动化部署：使用CI/CD管道自动化部署过程。MkDocs与GitHub Actions集成良好，使其易于持续部署更新的文档到GitHub Pages。

java代码规范，你了解多少？

一、为啥要有代码规范？

1.代码规范可以加快团队间的协作

对于每个项目的开发，大多数是由一个团队来完成的，团队内部的人来自四面八方，每个人的代码风格也大不相同，如果没有统一的代码规范，那么代码的可读性会大大降低，会严重影响团队的开发效率。这就好比几个人在一起交流，小王用地道的四川话，小李用地道的湖南话、小王用浓厚的广东话，试想一下，他们相互之间能畅快的交谈吗？显然不能，他们可能各自都听不懂对方的口音，假如他们都改用普通话，那么问题不就解决了？如此可见，代码规范就好比我们的普通话，统一标准，才能加快团队间的协作。

2.代码规范可以降低维护成本

作为程序员，我想90%的人都应该维护过别人的代码，当你第一眼看到别人的代码时，你的心情是怎么样的？要么欣喜，要么沮丧！欣喜的是，你拿到代码，能很快上手，花费很短的时间就能把一个新加的功能给做好；沮丧的是，你看到代码头就大，可读性差、模块重用性不高，变量命名不规范等，一下子就丧失了信心，再加上领导隔三差五的催赶进度，是不是很崩溃？回过头来，再说代码规范为啥可以降低维护成本，首先，代码规范增加了代码的可读性，提高了代码维护的效率，缩短了开发周期，不是节约了成本吗？其次，代码规范可提高代码的复用程度，举个例子，新增一个新功能，本来需要编写1000行代码，但是由于之前代码复用度高，缩减到300行就能实现，节省了700行代码，不也解约了成本吗？

3.代码规范有助于代码审查

代码审查是项目开发过程中的一个必要环节，代码审查的目的在于发现代码逻辑中潜在的错误，代码审查的方式一般可以通过静态扫描工具或人工走查的方式进行。静态扫描工具大多只能扫描代码的语法规范，常见的语法逻辑问题，对于业务逻辑操作还得靠人工的方式进行。人工进行代码走查时，一般是相互走查，A同学写的代码由B同学走查，代码走查是一个很好的学习机会，对成员的进步也是很有益的。随意编写的代码，不遵循编码规范，会加重的代码审查的工作量及难度，浪费大量的人力物力。 代码规范让代码审查有据可查，大大提高了审查效率和效果。

4.代码规范有助于提高程序员自身素质

我认为要想成为一个高素质的程序员，最基本的要求就是要有良好的代码规范，代码规范好比一个人的穿衣打扮，那些穿衣华丽、衣冠整洁的人走到哪里都会成为亮点，相反那些整天衣衫不整、浑身散发着特殊气味的人一定会被嫌弃！有空阅读一下java JDK的源码，那些都是大牛们的杰作，阅读时真是赏心悦目！好的代码习惯不是一朝一夕都能养成的，是要经过长期的训练、积累总结才能养成。

二、常见java代码规范有哪些?

以下是我在工作中总结的代码规范(部分规范参考第三方平台的内容），有兴趣的可以收藏。

1. 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。反 例 ：_name / name / $name / name_ / name$ / name

2. 【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。

正例：shaighai / zhengzhou / youku / hangzhou 等国际通用的名称，可视同英文。反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

3. 【强制】类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。

正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

4. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。

正例： localValue / getHttpMessage() / inputUserId

5. 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。正例：MAX_STOCK_COUNT

反例：MAX_COUNT

6. 【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。

7. 【强制】类型与中括号紧挨相连来表示数组。正例：定义整形数组 int[] arrayDemo;

反例：在 main 参数中，使用 String args[]来定义。

8. 【强制】POJO 类中布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误。反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()，RPC

框架在反向解析的时候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。

9. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。

10. 【推荐】杜绝完全不规范的缩写，避免望文不知义。

反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。

11. 【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。

正例：在 JDK 中，表达原子更新的类名为：AtomicReferenceFieldUpdater。反例：变量 int a 的随意命名方式。

12. 【推荐】如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。

正例：public class OrderFactory; public class LoginProxy;

public class ResourceObserver;

13. 【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。

正例：接口方法签名 void commit();

接口基础常量 String COMPANY = \”youqu\”;

反例：接口方法定义 public abstract void f();

说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。

14. 接口和实现类的命名有两套规则：

1） 【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl 的后缀与接口区别。

正例：CacheServiceImpl 实现 CacheService 接口。

2） 【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是–able 的形式） 。正例：AbstractTranslator 实现 Translatable 接口。

15. 【参考】各层命名规约：

A) Service/DAO 层方法命名规约

1） 获取单个对象的方法用 get 做前缀。

2） 获取多个对象的方法用 list 做前缀，复数形式结尾如：listObjects。

3） 获取统计值的方法用 count 做前缀。

4） 插入的方法用 save/insert 做前缀。

5） 删除的方法用 remove/delete 做前缀。

6） 修改的方法用 update 做前缀。

B) 领域模型命名规约

1） 数据对象：xxxDO，xxx 即为数据表名。

2） 数据传输对象：xxxDTO，xxx 为业务领域相关的名称。

3） 展示对象：xxxVO，xxx 一般为网页名称。

4） POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

1. 【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。反例：String key = \”Id#Super_\” + tradeId;

cache.put(key, value);

2. 【强制】在 long 或者 Long 赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数字

1 混淆，造成误解。

说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2?

3. 【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。

说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。

4. 【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。

1） 跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。

2） 应用内共享常量：放置在一方库中，通常是子模块中的 constant 目录下。

反例：易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示

“是”的变量：

3） 类 A 中：public static final String YES = \”yes\”;

4） 类 B 中 ：public static final String YES = \”y\”; A.YES.equals(B.YES)，预期是 true，但实际返回为 false，导致线上问题。

5） 子工程内部共享常量：即在当前子工程的 constant 目录下。

6） 包内共享常量：即在当前包下单独的 constant 目录下。

7） 类内共享常量：直接在类内部 private static final 定义。

1. 【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：

1） 左大括号前不换行。

2） 左大括号后换行。

3） 右大括号前换行。

4） 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。

2.

【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；而左大括号前需要空格。详见第 5 条下方正例提示。

反例：if (空格 a == b 空格)

3. 【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。

4. 【强制】任何二目、三目运算符的左右两边都需要加一个空格。

说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

5. 【强制】采用 4 个空格缩进，禁止使用 tab 字符。

说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时， 请勿勾选 Use tab character；而在 eclipse 中，必须勾选 insert spaces for tabs。

6. 【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：

1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。

2） 运算符与下文一起换行。

3） 方法调用的点符号与下文一起换行。

4） 方法调用中的多个参数需要换行时，在逗号后进行。

5） 在括号前不要换行，见反例。正例：

StringBuffer sb = new StringBuffer();

// 超过 120 个字符的情况下，换行缩进 4 个空格，点号和方法名称一起换行

sb.append(\”zi\”).append(\”xin\”)…

.append(\”huang\”)…

.append(\”huang\”)…

.append(\”huang\”);

反例：

StringBuffer sb = new StringBuffer();

// 超过 120 个字符的情况下，不要在括号前换行

sb.append(\”zi\”).append(\”xin\”)…append (\”huang\”);

// 参数很多的方法调用可能超过 120 个字符，不要在逗号前换行

method(args1, args2, args3, …

, argsX);

7. 【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。正例：下例中实参的 args1，后边必须要有一个空格。

method(args1, args2, args3);

8. 【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式， 不要使用 Windows 格式。

9. 【推荐】单个方法的总行数不超过 80 行。

说明：包括方法签名、结束右大括号、方法内代码、注释、空行、回车及任何不可见字符的总行数不超过 80 行。

正例：代码逻辑分清红花和绿叶，个性和共性，绿叶逻辑单独出来成为额外方法，使主干代码更加清晰；共性逻辑抽取成为共性方法，便于复用和维护。

10. 【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。说明：任何情形，没有必要插入多个空行进行隔开。

1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。

2. 【强制】所有的覆写方法，必须加@Override 注解。

说明：getObject()与 get0bject()的问题。一个是字母的 O，一个是数字的 0，加@Override 可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。

3. 【推荐】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。说明：可变参数必须放置在参数列表的最后。（提倡同学们尽量不用可变参数编程）

正例：public List<User> listUsers(String type, Long… ids) {…}

4. 【推荐】不能使用过时的类或方法。

说明：java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时，应

该使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口， 那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。

5. 【强制】Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用

equals。

正例：\”test\”.equals(object); 反例：object.equals(\”test\”);

说明：推荐使用 java.util.Objects#equals（JDK7 引入的工具类）

6. 关于基本数据类型与包装数据类型的使用标准如下：

1） 【强制】所有的 POJO 类属性必须使用包装数据类型。

2） 【强制】RPC 方法的返回值和参数必须使用包装数据类型。

3） 【推荐】所有的局部变量使用基本数据类型。

说明：POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何

NPE 问题，或者入库检查，都由使用者来保证。

正例：数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。反例：比如显示成交总额涨跌情况，即正负 x%，x 为基本数据类型，调用的 RPC 服务，调用不成功时，返回的是默认值，页面显示为 0%，这是不合理的，应该显示成中划线。所以包装数据类型的 null 值，能够表示额外的信息，如：远程调用失败，异常退出。

7. 【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。

反例：POJO 类的 gmtCreate 默认值为 new Date()，但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

8. 【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。

说明：注意 serialVersionUID 不一致会抛出序列化运行时异常。

9. 【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。

10. 【强制】POJO 类必须写 toString 方法。使用 IDE 中的工具：source> generate toString

时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。

说明：在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排查问题。

11. 【强制】禁止在 POJO 类中，同时存在对应属性 xxx 的 isXxx()和 getXxx()方法。说明：框架在调用属性 xxx 的提取方法时，并不能确定哪个方法一定是被优先调用到。

12. 【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛 IndexOutOfBoundsException 的风险。

说明：

String str = \”a,b,c,,\”;

String[] ary = str.split(\”,\”);

// 预 期 大 于 3， 结 果 是 3 System.out.println(ary.length);

13. 【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起， 便于阅读，此条规则优先于第 16 条规则。

14. 【推荐】 类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter

方法。

说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为承载的信息价值较低，所有 Service 和 DAO 的 getter/setter 方法放在类体最后。

15. 【推荐】setter 方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在

getter/setter 方法中，不要增加业务逻辑，增加排查问题的难度。反例：

public Integer getData() { if (condition) {

return this.data + 100;

} else {

return this.data – 100;

}

}

16. 【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。说明：下例中，反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象， 然后进行 append 操作，最后通过 toString 方法返回 String 对象，造成内存资源浪费。 反例：

String str = \”start\”;

for (int i = 0; i < 100; i++) { str = str + \”hello\”;

}

17. 【推荐】final 可以声明类、成员变量、方法、以及本地变量，下列情况使用 final 关键字：

1） 不允许被继承的类，如：String 类。

2） 不允许修改引用的域对象。

3） 不允许被重写的方法，如：POJO 类的setter 方法。

4） 不允许运行过程中重新赋值的局部变量。

5） 避免上下文重复使用一个变量，使用 final 描述可以强制重新定义一个变量，方便更好地进行重构。

18. 【推荐】慎用 Object 的 clone 方法来拷贝对象。

说明：对象的 clone 方法默认是浅拷贝，若想实现深拷贝需要重写 clone 方法实现域对象的深度遍历式拷贝。

19. 【推荐】类成员与方法访问控制从严：

1） 如果不允许外部直接通过 new 来创建对象，那么构造方法必须是 private。

2） 工具类不允许有 public 或 default 构造方法。

3） 类非 static 成员变量并且与子类共享，必须是 protected。

4） 类非 static 成员变量并且仅在本类使用，必须是 private。

5） 类 static 成员变量如果仅在本类使用，必须是 private。

6） 若是 static 成员变量，考虑是否为 final。

7） 类成员方法只供类内部调用，必须是 private。

8） 类成员方法只对继承类公开，那么限制为 protected。

说明：任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。思考：如果是一个 private 的方法，想删除就删除，可是一个 public 的 service 成员方法或成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你会担心的。

1. 【强制】关于 hashCode 和 equals 的处理，遵循如下规则：

1） 只要重写 equals，就必须重写 hashCode。

2） 因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的对象必须重写这两个方法。

3） 如果自定义对象作为 Map 的键，那么必须重写 hashCode 和 equals。

说明：String 重写了hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象作为 key 来使用。

2. 【强制】使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全一样的数组，大小就是 list.size()。

说明：使用 toArray 带参方法，入参分配的数组空间不够大时，toArray 方法内部将重新分配内存空间，并返回新数组地址；如果数组元素个数大于实际所需，下标为[ list.size() ] 的数组元素将被置为 null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素个数一致。

正例：

List<String> list = new ArrayList<String>(2); list.add(\”guan\”);

list.add(\”bao\”);

String[] array = new String[list.size()]; array = list.toArray(array);

反例：直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object[]类，若强转其它类型数组将出现 ClassCastException 错误。

3. 【强制】使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。

说明：asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList体现的是适配器模式，只是转换接口，后台的数据仍是数组。

String[] str = new String[] { \”you\”, \”wu\” }; List list = Arrays.asList(str);

第一种情况：list.add(\”yangguanbao\”); 运行时异常。

第二种情况：str[0] = \”gujin\”; 那么 list.get(0)也会随之修改。

4. 【强制】不要在 foreach 循环里进行元素的remove/add 操作。remove 元素请使用 Iterator

方式，如果并发操作，需要对 Iterator 对象加锁。正例：

List<String> list = new ArrayList<>(); list.add(\”1\”);

list.add(\”2\”);

Iterator<String> iterator = list.iterator(); while (iterator.hasNext()) {

String item = iterator.next(); if (删除元素的条件) {

iterator.remove();

}

}

反例：

for (String item : list) { if (\”1\”.equals(item)) {

list.remove(item);

}

}

说明：以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的结果吗？

5. 【强制】在 JDK7 版本及以上，Comparator 实现类要满足如下三个条件，不然 Arrays.sort，

Collections.sort 会报 IllegalArgumentException 异常。说明：三个条件如下

1） x，y 的比较结果和 y，x 的比较结果相反。

2） x>y，y>z，则x>z。

3） x=y，则x，z 比较结果和 y，z 比较结果相同。

反例：下例中没有处理相等的情况，实际使用中可能会出现异常：

new Comparator<Student>() {

@Override

public int compare(Student o1, Student o2) { return o1.getId() > o2.getId() ? 1 : -1;

}

};

6. 【推荐】集合泛型定义时，在 JDK7 及以上，使用 diamond 语法或全省略。说明：菱形泛型，即 diamond，直接使用<>来指代前边已经指定的类型。

正例：

// <> diamond 方式

HashMap<String, String> userCache = new HashMap<>(16);

// 全省略方式

ArrayList<User> users = new ArrayList(10);

7. 【推荐】集合初始化时，指定集合初始值大小。

说明：HashMap 使用 HashMap(int initialCapacity) 初始化。

正例：initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子（即 loader

factor）默认为 0.75，如果暂时无法确定初始值大小，请设置为 16（即默认值）。

反例：HashMap 需要放置 1024 个元素，由于没有设置容量初始大小，随着元素不断增加，容量 7 次被迫扩大，resize 需要重建 hash 表，严重影响性能。

8. 【推荐】使用 entrySet 遍历 Map 类集合KV，而不是 keySet 方式进行遍历。

说明：keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出key 所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效率更高。如果是 JDK8，使用 Map.foreach 方法。

正例：values()返回的是 V 值集合，是一个list 集合对象；keySet()返回的是 K 值集合，是一个 Set 集合对象；entrySet()返回的是 K-V 值组合集合。

9. 【推荐】高度注意 Map 类集合 K/V 能不能存储 null 值的情况，如下表格：

反例： 由于 HashMap 的干扰，很多人认为 ConcurrentHashMap 是可以置入 null 值，而事实上， 存储 null 值时会抛出 NPE 异常。

10. 【参考】合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。

说明：有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是一定的。如：ArrayList 是 order/unsort；HashMap 是 unorder/unsort；TreeSet 是

order/sort。

11. 【参考】利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的

contains 方法进行遍历、对比、去重操作。

1. 【强制】获取单例对象需要保证线程安全，其中的方法也要保证线程安全。说明：资源驱动类、工具类、单例工厂类都需要注意。

2. 【推荐】创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。正例：

public class TimerTaskThread extends Thread { public TimerTaskThread() {

super.setName(\”TimerTaskThread\”);

…

}

}

3. 【推荐】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。

说明：使用线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。

4. 【推荐】线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。

说明：Executors 返回的线程池对象的弊端如下：

1） FixedThreadPool 和 SingleThreadPool:

允许的请求队列长度为 Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM。

2） CachedThreadPool 和 ScheduledThreadPool:

允许的创建线程数量为 Integer.MAX_VALUE，可能会创建大量的线程，从而导致 OOM。

5. 【强制】SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为

static，必须加锁，或者使用 DateUtils 工具类。

正例：注意线程安全，使用 DateUtils。亦推荐如下处理：

private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() {

@Override

protected DateFormat initialValue() {

return new SimpleDateFormat(\”yyyy-MM-dd\”);

}

};

说明：如果是 JDK8 的应用，可以使用 Instant 代替 Date，LocalDateTime 代替 Calendar，

DateTimeFormatter 代替 SimpleDateFormat，官方给出的解释：simple beautiful strong immutable thread-safe。

6. 【推荐】高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。

说明：尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用 RPC 方法。

7. 【推荐】并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用 version 作为更新依据。

说明：如果每次访问冲突概率小于 20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于 3 次。

8. 【强制】多线程并行处理定时任务时，Timer 运行多个 TimeTask 时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，使用 ScheduledExecutorService 则没有这个问题。

9. 【强制】禁止在循环语句中进行数据库增删改查操作，高并发时，会耗尽数据库连接池资源，如果遇到耗时的操作，会导致连接占用时间过长而一直得不到释放，会造成其他请求获取不到连接的情况。循环插入、更新、删除数据库可以使用jdbc batch update进行操作，循环查询数据库可以一次查询满足条件的所有数据，然后再进行筛选。

10. 【推荐】使用 CountDownLatch 进行异步转同步操作，每个线程退出前必须调用 countDown 方法，线程执行代码注意 catch 异常，确保 countDown 方法被执行到，避免主线程无法执行至 await 方法，直到超时才返回结果。

说明：注意，子线程抛出异常堆栈，不能在主线程 try-catch 到。

11. 【推荐】避免 Random 实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一

seed 导致的性能下降。

说明：Random 实例包括 java.util.Random 的实例或者 Math.random()的方式。

正例：在 JDK7 之后，可以直接使用 API ThreadLocalRandom，而在 JDK7 之前，需要编码保证每个线程持有一个实例。

12. 【参考】volatile 解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题， 但是如果多写，同样无法解决线程安全问题。如果是 count++操作，使用如下类实现： AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 如果是 JDK8，推荐使用 LongAdder 对象，比 AtomicLong 性能更好（减少乐观锁的重试次数）。

13. 【参考】 HashMap 在容量不够进行 resize 时由于高并发可能出现死链，导致 CPU 飙升，在开发过程中可以使用其它数据结构或加锁来规避此风险。

14. 【参考】ThreadLocal 无法解决共享对象的更新问题，ThreadLocal 对象建议使用 static 修饰。这个变量是针对一个线程内所有操作共享的，所以设置为静态变量，所有此类实例共享此静态变量 ，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。

1. 【强制】在一个 switch 块内，每个 case 要么通过 break/return 等来终止，要么注释说明程序将继续执行到哪一个 case 为止；在一个 switch 块内，都必须包含一个 default 语句并且放在最后，即使空代码。

2. 【强制】在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用单行的编码方式：if (condition) statements;

3. 【推荐】表达异常的分支时，少用 if-else 方式，这种方式可以改写成：

if (condition) {

…

return obj;

}

// 接着写 else 的业务逻辑代码;

说明：如果非得使用 if()…else if()…else…方式表达逻辑，【强制】避免后续代码维护困难，请勿超过 3 层。

正例：超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现， 其中卫语句示例如下：

public void today() { if (isBusy()) {

System.out.println(“change time.”); return;

}

if (isFree()) {

System.out.println(“go to travel.”); return;

}

System.out.println(“stay at home to learn Alibaba Java Coding Guidelines.”); return;

}

4. 【推荐】除常用方法（如 getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。

说明：很多 if 语句内的逻辑相当复杂，阅读者需要分析条件表达式的最终结果，才能明确什么样的条件执行什么样的语句，那么，如果阅读者分析逻辑表达式错误呢？

正例：

// 伪代码如下

final boolean existed = (file.open(fileName, \”w\”) != null) && (…) || (…); if (existed) {

…

}

反例：

if ((file.open(fileName, \”w\”) != null) && (…) || (…)) {

…

}

5. 【推荐】循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的 try-catch 操作（这个 try-catch 是否可以移至循环体外）。

6. 【推荐】避免采用取反逻辑运算符。

说明：取反逻辑不利于快速理解，并且取反逻辑写法必然存在对应的正向逻辑写法。正例：使用 if (x < 628) 来表达 x 小于 628。

反例：使用 if (!(x >= 628)) 来表达 x 小于 628。

7. 【参考】下列情形，需要进行参数校验：

1） 调用频次低的方法。

2） 执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。

3） 需要极高稳定性和可用性的方法。

4） 对外提供的开放接口，不管是 RPC/API/HTTP 接口。

5） 敏感权限入口。

8. 【参考】下列情形，不需要进行参数校验：

1） 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。

2） 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般 DAO 层与 Service 层都在同一个应用中，部署在同一台服务器中，所以 DAO 的参数校验，可以省略。

3） 被声明成 private 只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。

1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容*/格式，不得使用

// xxx 方式。

说明：在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释；在 IDE 中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。

2. 【强制】所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。

说明：对子类的实现要求，或者调用注意事项，请一并说明。

3. 【强制】所有的类都必须添加创建者和创建日期。

4. 【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。

5. 【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。

6. 【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。

反例：“TCP 连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。

7. 【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。

说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后， 就失去了导航的意义。

8. 【参考】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。

说明：代码被注释掉有两种可能性：1）后续会恢复此段代码逻辑。2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。

9. 【参考】对于注释的要求：第一、能够准确反应设计思想和代码逻辑；第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。

10. 【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。

反例：

// put elephant into fridge put(elephant, fridge);

方法名 put，加上两个有意义的变量名 elephant 和 fridge，已经说明了这是在干什么，语

义清晰的代码不需要额外的注释。

11. 【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描， 经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。 1） 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）

表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，目前的 Javadoc

还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个 Javadoc 标签）。

2） 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）

在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况。

1. 【强制】velocity 调用 POJO 类的属性时，建议直接使用属性名取值即可，模板引擎会自动按规范调用 POJO 的 getXxx()，如果是 boolean 基本数据类型变量（boolean 命名不需要加 is 前缀），会自动调用 isXxx()方法。

说明：注意如果是 Boolean 包装类对象，优先调用 getXxx()的方法。

2. 【强制】注意 Math.random() 这个方法返回是 double 类型，注意取值的范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将 x 放大 10 的若干倍然后取整，直接使用 Random 对象的 nextInt 或者 nextLong 方法。

3. 【强制】获取当前毫秒数 System.currentTimeMillis(); 而不是new Date().getTime(); 说明：如果想获取更加精确的纳秒级时间值，使用 System.nanoTime()的方式。在 JDK8 中， 针对统计时间等场景，推荐使用 Instant 类。

4. 【推荐】任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。

5. 【推荐】及时清理不再使用的代码段或配置信息。

说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。

正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///)来说明注释掉代码的理由。

1. 【强制】Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该通过

catch 的方式来处理，比如：NullPointerException，IndexOutOfBoundsException 等等。说明：无法通过预检查的异常除外，比如，在解析字符串形式的数字时，不得不通过 catch

NumberFormatException 来实现。正例：if (obj != null) {…}

反例：try { obj.method(); } catch (NullPointerException e) {…}

2. 【强制】异常不要用来做流程控制，条件控制。

说明：异常设计的初衷是解决程序运行中的各种意外情况，且异常的处理效率比条件判断方式要低很多。

3. 【强制】catch 时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分异常类型，再做对应的异常处理。

说明：对大段代码进行 try–catch，使程序无法根据不同的异常做出正确的应激反应，也不利于定位问题，这是一种不负责任的表现。

正例：用户注册的场景中，如果用户输入非法字符，或用户名称已存在，或用户输入密码过于简单，在程序上作出分门别类的判断，并提示给用户。

4. 【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。

5. 【强制】有 try 块放到了事务代码中，catch 异常后，如果需要回滚事务，一定要注意手动回滚事务。

6. 【强制】finally 块必须对资源对象、流对象进行关闭，有异常也要做 try-catch。说明：如果 JDK7 及以上，可以使用 try-with-resources 方式。

7. 【强制】不要在 finally 块中使用 return。

说明：finally 块中的 return 返回后方法结束执行，不会再执行 try 块中的 return 语句。

8. 【强制】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。

9. 【推荐】方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回 null 值。

说明：本手册明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败、序列化失败、运行时异常等场景返回

null 的情况。

10. 【推荐】防止 NPE，是程序员的基本修养，注意 NPE 产生的场景：

1） 返回类型为基本数据类型，return 包装数据类型的对象时，自动拆箱有可能产生 NPE。反例：public int f() { return Integer 对象}， 如果为null，自动解箱抛 NPE。

2） 数据库的查询结果可能为 null。

3） 集合里的元素即使 isNotEmpty，取出的数据元素也可能为 null。

4） 远程调用返回对象时，一律要求进行空指针判断，防止 NPE。

5） 对于 Session 中获取的数据，建议 NPE 检查，避免空指针。

6） 级联调用 obj.getA().getB().getC()；一连串调用，易产生 NPE。正例：使用 JDK8 的 Optional 类来防止 NPE 问题。

11. 【推荐】定义时区分 unchecked / checked 异常，避免直接抛出 new RuntimeException()， 更不允许抛出 Exception 或者 Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：DAOException / ServiceException 等。

12. 【参考】对于公司外的 http/api 开放接口必须使用“错误码”；而应用内部推荐异常抛出； 跨应用间 RPC 调用优先考虑使用 Result 方式，封装 isSuccess()方法、“错误码”、“错误简短信息”。

说明：关于 RPC 方法返回方式使用 Result 方式的理由：

1） 使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。

2） 如果不加栈信息，只是 new 自定义异常，加入自己的理解的 error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。

13. 【参考】避免出现重复的代码（Don’t Repeat Yourself），即 DRY 原则。

说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是组件化。

正例：一个类中有多个 public 方法，都需要进行数行相同的参数校验操作，这个时候请抽取：

private boolean checkParam(DTO dto) {…}

1. 【强制】应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架

SLF4J 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

private static final Logger logger = LoggerFactory.getLogger(Abc.class);

2. 【强制】对 trace/debug/info 级别的日志输出，必须使用条件输出形式或者使用占位符的方式。

说明：logger.debug(\”Processing trade with id: \” + id + \” and symbol: \” + symbol); 如果日志级别是 warn，上述日志不会打印，但是会执行字符串拼接操作，如果 symbol 是对象，会执行 toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。

正例：（条件）建设采用如下方式

if (logger.isDebugEnabled()) {

logger.debug(\”Processing trade with id: \” + id + \” and symbol: \” + symbol);

}

正例：（占位符）

logger.debug(\”Processing trade with id: {} and symbol : {} \”, id, symbol);

3. 【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。正例：<logger name=\”com.test.dubbo.config\” additivity=\”false\”>

4. 【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字 throws 往上抛出。

正例：logger.error(各类参数或者对象 toString() + \”_\” + e.getMessage(), e);

5. 【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。

说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？

6. 【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出 error 级别，避免频繁报警。

说明：注意日志输出的级别，error 级别只记录系统逻辑出错、异常或者重要的错误信息。

1. 【强制】用户输入的 SQL 参数严格使用参数绑定或者 METADATA 字段值限定，防止 SQL 注入， 禁止字符串拼接 SQL 访问数据库。

2. 【强制】数据库连接字符串不应当在应用程序中硬编码。连接字符串应当存储在一个可信服务器的独立配置文件中，必要时，账户和密码字段需要加密。

3. 【推荐】当应用程序访问数据库时，应使用尽可能最低的权限。

1. 【强制】关闭服务器中文件上传目录的运行权限，防止或限制上传任意可能被 Web服务器解析的文件。

2. 【推荐】将 Web服务器、进程和服务的账户限制为尽可能低的权限。

3. 【推荐】为存储在服务器中的敏感信息提供恰当的访问控制。这包括缓存的数据、临时文件以及只允许特定系统用户访问的数据。

1. 【强制】用户请求传入的任何参数必须做有效性验证。说明：忽略参数校验可能导致：

l page size 过大导致内存溢出

l 恶意 order by 导致数据库慢查询

l 任意重定向

l SQL 注入

l 反序列化注入

l 正则输入源串拒绝服务 ReDoS

说明：Java 代码用正则来验证客户端的输入，有些正则写法验证普通用户输入没有问题， 但是如果攻击人员使用的是特殊构造的字符串来验证，有可能导致死循环的结果。

2. 【强制】禁止向 HTML 页面输出未经安全过滤或未正确转义的用户数据。

3. 【强制】表单、AJAX 提交必须执行 CSRF 安全验证。

说明：CSRF(Cross-site request forgery)跨站请求伪造是一类常见编程漏洞。对于存在

CSRF 漏洞的应用/网站，攻击者可以事先构造好 URL，只要受害者用户一访问，后台便在用户不知情的情况下对数据库中用户参数进行相应修改。

4. 【推荐】为包含敏感信息或功能、且连接到外部系统的连接使用 TLS。

5. 【强制】不要在 HTTP GET请求参数中包含敏感信息。

6. 【强制】禁止表单中的自动填充功能，因为表单中可能包含敏感信息，包括身份验证信息。

7. 【强制】禁止客户端缓存网页，因为可能包含敏感信息。“Cache-Control: no-store”，可以和 HTTP报头控制“Pragma: no-cache”一起使用，该控制不是非常有效，但是与 HTTP/1.0向后兼容。

8. 【推荐】为防范对随机数据的猜测攻击，应当使用加密模块中已验证的随机数生成器生成所有的随机数、随机文件名、随机 GUID和随机字符串。

9. 【强制】不要在错误响应中泄露敏感信息，包括：系统的详细信息、会话标识符或者帐号信息。

10. 【推荐】不要在日志中保存敏感信息，包括：不必要的系统详细信息、会话标识符或密码。

11. 【强制】限制只有授权的用户才能访问受保护的 URL。

12. 【强制】不要在 URL、错误信息或日志中暴露会话标识符。会话标识符应当只出现在 HTTP cookie头信息中。比如，不要将会话标识符以 GET 参数进行传递。

13. 【推荐】如果任何潜在的 危险字符 必须被作为输入，请确保您执行了额外的控制，比如：输出编码、特定的安全 API、以及在应用程序中使用的原因。部分常见的危险字符包括：< > \” \’ % ( ) & + \\ \\\’ \\\” 。

1. 【推荐】为所有要求身份验证的访问内容和所有其他的敏感信息提供 TLS连接

2. 【强制】在身份验证的时候，如果连接从 HTTP变为 HTTPS，则生成一个新的会话标识符。在应用程序中，推荐持续使用 HTTPS，而非在 HTTP和 HTTPS之间转换。

3. 【强制】所有的身份验证过程必须在可信系统（比如：服务器）上执行，身份验证的失败提示信息应当避免过于明确。比如：可以使用“用户名和/或密码错误”，而不要使用“用户名错误”或者“密码错误”。错误提示信息在显示和源代码中应保持一致。

1. 【强制】表名必须以t_开头，如：t_user，函数以f_开头，存储过程已p_开头，视图以v_开头。

2. 【强制】字段名按照不同的数据类型进行命名，字符、文本类型以c_开头，如：c_user_name,整型（包含int,tinyint,bigint）、数字类型都统一以n_开头、时间类型用长时间格式进行存储，也以n_开头，double数据类型以d_开头，float数据类型以f_开头。

3. 【强制】表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。说明：MySQL 在 Windows 下不区分大小写，但在 Linux 下默认是区分大小写。因此，数据库名、表名、字段名，都不允许出现任何大写字母，避免节外生枝。

正例：super_admin，rpc_config，level3_name 反例：superAdmin，rpcConfig，level_3_name

4. 【强制】表名不使用复数名词。

说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于 DO 类名也是单数形式，符合表达习惯。

5. 【强制】禁用保留字，如 desc、range、match、delayed 等，请参考 MySQL 官方保留字。

6. 【强制】主键索引名为 pk_字段名；唯一索引名为 uk_字段名；普通索引名则为 idx_字段名。说明：pk_ 即 primary key；uk_ 即 unique key；idx_ 即 index 的简称。

7. 【强制】varchar 是可变长字符串，不预先分配存储空间，长度不要超过 5000，如果存储长度大于此值，定义字段类型为 text，独立出来一张表，用主键来对应，避免影响其它字段索引效率。

8. 【推荐】库名与应用名称尽量一致。

9. 【推荐】如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。

10. 【推荐】字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循： 1）不是频繁修改的字段。

2）不是 varchar 超长字段，更不能是 text 字段。

正例：商品类目名称使用频率高，字段长度短，名称基本一成不变，可在相关联的表中冗余存储类目名称，避免关联查询。

11. 【推荐】单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。

说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。

12. 【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。

正例：如下表，其中无符号值可以避免误存负数，且扩大了表示范围。

1. 【强制】业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。

说明：不要以为唯一索引影响了 insert 速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。

2. 【强制】超过三个表禁止 join。需要 join 的字段，数据类型必须绝对一致；多表关联查询时， 保证被关联的字段需要有索引。

说明：即使双表 join 也要注意表索引、SQL 性能。

3. 【推荐】在 varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。

说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为 20 的索引，区分度会高达 90%以上，可以使用 count(distinct left(列名, 索引长度))/count(*)的区分度来确定。

4. 【推荐】如果有 order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现 file_sort 的情况，影响查询性能。正例：where a=? and b=? order by c; 索引：a_b_c

反例：索引中有范围查找，那么索引有序性无法利用，如：WHERE a>10 ORDER BY b; 索引

a_b 无法排序。

5. 【推荐】利用覆盖索引来进行查询操作，避免回表。

说明：如果一本书需要知道第 11 章是什么标题，会翻开第 11 章对应的那一页吗？目录浏览一下就好，这个目录就是起到覆盖索引的作用。

正例：能够建立索引的种类分为主键索引、唯一索引、普通索引三种，而覆盖索引只是一种查询的一种效果，用 explain 的结果，extra 列会出现：using index。

6. 【推荐】利用延迟关联或者子查询优化超多分页场景。

说明：MySQL 并不是跳过 offset 行，而是取 offset+N 行，然后返回放弃前 offset 行，返回

N 行，那当 offset 特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特定阈值的页数进行 SQL 改写。

正例：先快速定位需要获取的 id 段，然后再关联：

SELECT a.* FROM 表 1 a, (select id from 表 1 where 条件 LIMIT 100000,20 ) b where a.id=b.id

7. 【推荐】SQL 性能优化的目标：至少要达到 range 级别，要求是 ref 级别，如果可以是 consts

最好。说明：

1） consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。

2） ref 指的是使用普通的索引（normal index）。

3） range 对索引进行范围检索。

反例：explain 表的结果，type=index，索引物理文件全扫描，速度非常慢，这个 index 级别比较 range 还低，与全表扫描是小巫见大巫。

8. 【推荐】建组合索引的时候，区分度最高的在最左边。

正例：如果 where a=? and b=? ，如果a 列的几乎接近于唯一值，那么只需要单建 idx_a

索引即可。

说明：存在非等号和等号混合时，在建索引时，请把等号条件的列前置。如：where c>? and

d=? 那么即使 c 的区分度更高，也必须把 d 放在索引的最前列，即索引 idx_d_c。

9. 【推荐】防止因字段类型不同造成的隐式转换，导致索引失效。

10. 【参考】创建索引时避免有如下极端误解：

1） 宁滥勿缺。认为一个查询就需要建一个索引。

2） 宁缺勿滥。认为索引会消耗空间、严重拖慢更新和新增速度。

3） 抵制惟一索引。认为业务的惟一性一律需要在应用层通过“先查后插”方式解决。

1. 【强制】不要使用 count(列名)或 count(常量)来替代 count(*)，count(*)是 SQL92 定义的标准统计行数的语法，跟数据库无关，跟 NULL 和非 NULL 无关。

说明：count(*)会统计值为 NULL 的行，而 count(列名)不会统计此列为 NULL 值的行。

2. 【强制】count(distinct col) 计算该列除 NULL 之外的不重复行数，注意 count(distinct col1, col2) 如果其中一列全为 NULL，那么即使另一列有不同的值，也返回为 0。

3. 【强制】当某一列的值全是 NULL 时，count(col)的返回结果为 0，但 sum(col)的返回结果为NULL，因此使用 sum()时需注意 NPE 问题。

正例：可以使用如下方式来避免 sum 的 NPE 问题：SELECT IF(ISNULL(SUM(g)),0,SUM(g)) FROM table;

4. 【强制】使用 ISNULL()来判断是否为 NULL 值。说明：NULL 与任何值的直接比较都为 NULL。

1） NULL<>NULL 的返回结果是 NULL，而不是 false。

2） NULL=NULL 的返回结果是 NULL，而不是 true。

3） NULL<>1 的返回结果是 NULL，而不是 true。

5. 【强制】在代码中写分页查询逻辑时，若 count 为 0 应直接返回，避免执行后面的分页语句。

6. 【强制】不得使用外键与级联，一切外键概念必须在应用层解决。

说明：以学生和成绩的关系为例，学生表中的 student_id 是主键，那么成绩表中的 student_id 则为外键。如果更新学生表中的 student_id，同时触发成绩表中的 student_id 更新，即为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。

7. 【推荐】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。

8. 【推荐】数据订正（特别是删除、修改记录操作）时，要先 select，避免出现误删除，确认无误才能执行更新语句。

9. 【推荐】in 操作能避免则避免，若实在避免不了，需要仔细评估 in 后边的集合元素数量，控制在 1000 个之内。

10. 【参考】如果有国际化需要，所有的字符存储与表示，均以 utf-8 编码，注意字符统计函数的区别。

说明：

SELECT LENGTH(\”轻松工作\”)； 返回为 12

SELECT CHARACTER_LENGTH(\”轻松工作\”)； 返回为 4

如果需要存储表情，那么选择 utf8mb4 来进行存储，注意它与 utf-8 编码的区别。

11. 【参考】TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但 TRUNCATE

无事务且不触发 trigger，有可能造成事故，故不建议在开发代码中使用此语句。说明：TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。

Java代码之美，从遵循样式规范开始

01

为什么要代码样式规范

对于团队开发，不同的代码规范或不规范可能引起的问题包括但不限于：

1.代码可读性，代码是为了人阅读的，不是只为了机器执行；

2.代码format引发的大量的diff，干扰code review；

3.间接影响代码质量和团队协作效率。

在敏捷迭代的软件开发环境中，良好的代码规范不仅能够帮助团队成员快速理解彼此的代码，减少沟通成本，还能在代码维护和扩展时节省宝贵的时间。此外，一致的代码风格也是项目专业性的体现，能够给代码审查者和未来的维护者留下良好的第一印象。

02

探索Java代码规范

我们将深入探讨Java社区广泛认可的编码规范，包括但不限于Google Java Style和Oracle官方的编码指南。从命名约定、代码格式化、注释的使用，到错误处理和测试代码的编写，每一个细节都是构建高质量Java代码的关键。

a. 规范选择

上面列举了多项代码规范，在决定使用哪种规范之前，可以考虑三个方面：

• 明确目标：使用代码规范的目的是什么，只是为了项目内代码风格一致，还是为了和其他团队分享或者其他公司分享或者开源？
• 使用环境：开发阅读代码的环境是什么，GitHub、GitLab、公司内部的代码平台？
• 工具支持：code format工具支持情况，code sytle check工具支持情况，编译工具：maven、gradle，IDE：IntelliJ、Eclipse、VS Code；

综合上面的三个方面的考虑，优先选择Google Java Style。

b. 规范制定

Google Java Style部分代码样式团队难以接受，比如2空格缩进等，可以在原始Google Java Style基础上，适当定制化调整。

代码样式规范的使用分为两个方面：

• 代码格式化
• 代码样式校验

注意：code style 跟 check style 的「配置文件」必须对应，即按照code style format的代码check style不报错。

代码样式校验

代码格式化依赖于开发者手动进行格式化，为达到团队/项目代码样式规范的落地，需要有全面的自动化的代码检查。根据当前业界推荐，采用Checkstyle作为自动化代码样式校验工具。

需要对原始 Google Code Style 的google_checks进行定制，以适配上面intellij-java-jd-style.xml的定制。

• 修改google_checks中的内容：

除了上述的长度和缩进的代码样式校验，Checkstyle还可以配置其它代码校验，可根据团队接受情况予以配置。

03

最佳实践：如何将规范融入日常开发

a. IDEA配置Code Style

在 IntelliJ IDEA下，使用intellij-java-jd-style.xml进行代码格式化之前，需要先进行配置。

设置配置文件，路径：IntelliJ IDEA→Preference→Editor→Code Style，参考下图：

导入定制的Code Style文件：intellij-java-jd-style.xml

命名Scheme，如图中JD-Style，并启用该代码样式规范

b. IDEA使用Code Style

完成上述配置后，在Mac环境的IntelliJ IDEA中，可以对选中的代码格式化（快捷键：Option+Command+L）或者对选中的文件格式化（快捷键：Shift+Option+Command+L）

Check Style的配置和使用有两种主要方式：

1. 在开发环境IDE中，开发者配置插件后，可触发代码样式规范的检查，根据提示项进行代码修改；

2.在maven项目中，配置Check Style插件，可用命令行触发代码样式规范的检查，集成到CI (Continuous Integration)的自动化流水线中。

a. IDEA配置CheckStyle插件

在 IntelliJ IDEA下，安装Plugin，路径：IntelliJ IDEA→Preference→Plugins，参考下图：

下载配置文件checkstyle.xml，配置CheckStyle-IDEA插件，路径：IntelliJ IDEA→Preference→Tools→Checkstyle，增加自定义配置文件并命名，参考下图：

b. IDEA使用CheckStyle插件

安装配置CheckStyle插件后，工具窗口增加了CheckStyle Tab，在CheckStyle窗口进行check，可以选择：

• Check Current File
• Check Module
• Check Project

c. maven配置CheckStyle插件

参考Checkstyle maven插件的官方配置案例：多模块项目配置，通常我们在项目中新建build-tools模块，将checkstyle.xml等配置文件放在这个模块的resources目录下。

build-tools模块的pom.xml使用IDEA自动生成的配置文件，类似：

配置文件checkstyle.xml、checkstyle-suppressions.xml可以从coding中下载

父项目的pom.xml中，增加如下配置：

maven-checkstyle-plugin的配置<configuration>参数具体可参见checkstyle:check的参数说明。

这里对几项配置进行说明：

• plugins>plugin>executions>execution

• id可以自行决定，这里选择\”checkstyle\”；
• phase是绑定到maven lifecycle的哪个执行阶段，这里绑定到\”validate\”上，即执行maven validate的时候会执行该plugin任务；选择validate阶段可以保障checkstyle:check在代码编译之前执行，如果checkstyle检查出违反样式规范的问题，在代码编译之前就会报告出来；
• goals>goal是只绑定执行plugin的哪个任务，这里绑定的是\”check\”；

• plugins>plugin>configuration>failOnViolation

• 检查到违反样式规范的问题，打印出来，打印的问题级别根据checkstyle.xml中配置的severity确定；
• 将severity级别配置为error，并将failOnViolation设为true，检查到违反样式规范的问题时，会停止maven命令继续执行；

注意：failOnViolation与failOnError配置项的区别，failOnError在检查到问题时立即停止执行，failOnViolation在检查到问题时输出检查日志再停止执行。

按照上述配置，可达到在mvn编译代码前强制检查代码样式规范，发现违反规范的问题，不会继续java的编译、打包。

运行mvn package即可正常打包。

也可以单独执行命令：

注意：为了实现自动化代码样式规范检查，可以为项目配置行云流水线任务，设置代码评审的自动化检查：指定流水线作为卡点，指定为卡点的流水线需运行成功后MR才允许合并。

04

结语：代码规范-团队协作的桥梁

最后，我们总结下Java样式规范对于团队协作的重要性，鼓励每位开发者将这些规范内化为自己的编码习惯。因为代码规范不仅是个人技艺的体现，更是团队协作和项目成功的基石。

通过阅读本文，你将不仅了解到Java样式规范的重要性，还将掌握如何将这些规范应用到实际开发中，让你的代码变得更加优雅和强大。让我们一起追求编码的艺术，用规范的代码点亮编程的世界。

本文作者及来源:Renderbus瑞云渲染农场https://www.renderbus.com