SpringBoot 项目 代码规范
时间: 2024-05-03 07:04:28 浏览: 115
springboot代码申城器
在开发SpringBoot项目时,可以遵循以下代码规范:
1. 使用SpringBoot整合MyBatisplus3.5.1及以上版本,利用分页插件实现分页查询和自动生成代码功能。
2. 使用@Valid注解在请求方法的字段上进行参数校验,若校验不通过返回状态码为400。
3. 在service层代码中进行字段唯一性校验,可以在添加数据之前判断是否已存在,若存在则抛出异常。
4. 定义全局异常处理器@ControllerAdvice,用于拦截异常并统一处理。
5. 避免直接将异常信息返回给用户,可以定义全局异常处理来处理异常情况,以避免产生bug。
6. 将可配置信息如数据库密码、用户名等存放在配置文件中,通过读取配置文件参数实现配置。
7. 使用@JsonView注解控制输出内容,可以在不同的请求中隐藏一些字段[2]。
8. 在前后端分离开发中,定义统一的前置路由规范。
9. 将代码逻辑主要写在service层,除非特殊情况,少量逻辑可以放在controller层。
10. 在SpringBoot Web项目中,可以使用URL传参和默认参数设置。
通过以上代码规范,可以使SpringBoot项目的代码更加规范和易于维护。<span class="em">1</span><span class="em">2</span><span class="em">3</span>
#### 引用[.reference_title]
- *1* [springboot整合MyBatisplus,实现分页查询、根据表自动生成代码、生成库里所有表对应的代码等功能](https://download.csdn.net/download/qq_33417321/88240573)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"]
- *2* *3* [springboot 开发规范](https://blog.csdn.net/m0_51458935/article/details/126860940)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"]
[ .reference_list ]
阅读全文