User Tools

Site Tools


springmvc编码规范
<ol style="list-style-type: decimal;">
<li>
<p>

RequestMapping注解method参数与页面上对应的请求类型同步,如注解上无该参数则添加,查询数据的请求使用“GET”,增、删、改数据的请求使用“POST”。

</p>

P.S.如果一个RequestMapping在页面上既有get请求又有post请求,则不要在RequestMapping中限制method,也就是说不要写method=RequestMethod.POST或method=RequestMethod.GET

</li>
<li>

Controller、Service中方法如增、删、改数据时则在该方法上添加@Transactional注解。使用@Transactional注解时,不能在多次写操作之间加入return代码,要不就是在所有写操作之前做条件判断再return,要不就是抛出异常,否则不能作为事务回滚。

</li>
<li>

去除所有硬编码。

</li>
<li>

将所有以拼音命名的变量名、方法名、常量名、URL、文件名全部替换为英文。规则为变量名、方法名、URL统一为驼峰命名,首字母小写。常量为全部大写,单词之间使用下划线分隔。前端文件名为全部小写并以横线分隔。Java文件名驼峰命名并首字母大写。具体参见Java编码规范HTML_CSS编码规范JavaScript_jQuery编码规范

</li>
<li>

方法、关键变量、关键代码注释补全,例如Controller类中方法的注释即为该方法的作用。

</li>
<li>

关键代码日志输出。

</li>
<li>

Idea中带波浪线的代码如未使用则删除,冗余则抽取为公共代码。

</li>
<li>

代码缩进调整、去除当前类未使用的Import。

</li>
<li>

业务代码挪至Service层。

</li>
<li>
<p>

一个Controller方法对应一个请求,一个Service方法可以对应多个Controller。

</p>
</li>
</ol>
springmvc编码规范.txt · Last modified: 2023/03/08 16:05 by xujianglong