java开发的格式与书写规范

1.安装插件

1. 安装idea插件–eclipse code formatter

2. 按住ctrl + alt + S 然后点击 plugins —marketplace —installed— ok

2添加配置文件

下载好eclipse格式化文件 按住ctrl + alt + S，重启后会发现出现eclipse code formatter 选项，点击进入 按照图片进行配置，路径选择文件夹内eclipse-codestyle文件。

注意：每次保存需要 ctrl+alt +l。

2.注释规范

ctrl + alt + S — file and code templates – includes —file header，然后填写下面代码。

/**

• 应用模块名称:

• 代码描述:

• Copyright: Copyright © ${YEAR}, Inc. All rights reserved.

• Company:

• @author

• @since ${DATE} ${TIME}

*/

2.代码书写规范

---

​

1. 入参必须使用对象或者List,非特殊情况下不允许使用jsonobject。

2. service与dao层也尽量使用对象封装，减少参数罗列。

3. 参数传递非必要情况不要使用map传递。

4. 出参使用封装好的Result对象。

5. 接口文档书写需要详细 。

6. 在使用系统统一异常处理时 不需要使用try catch。

7. 在特别需要时 需要向统一异常处理方法维护异常类别。

8. 需要加入类注释与方法注释 详细请参考新人项目搭建文档。

9. 非特殊情况方式不允许使用@requstmapping。

10. 实体类需要继承 BaseEntity。

11. 尽量将同一业务的接口写到一个类中，通用方法抽取出来，并提交给组长，维护到文档中。

12. 服务间调用请参考ribbon与feign。

最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，不论你是刚入门Java开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！**](https://bbs.csdn.net/topics/618164986)

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！