后端开发规范

作者 江辉 日期 2016-01-02
后端开发规范

一、规范的意义

减少大家不必要的阅读难度,方便大家维护自己及他人的项目。无论你使用任何编辑器 请您在最后提交的时候 使用eclisep 或者 STS 或者 IDEA中的格式化工具(ctrl +F)格式化一下

二、注意点

2.1 编码

所有文件都采用UTF-8编码

2.2 @overwrite

重写某一个类的方法,必须加入@overwrite

三、命名规范

3.1 JAVA类命名规范

采用驼峰命名法,并第一个字母大写 eg. UserInfo.class

3.2 包命名规范

采用 com.项目名.模块名

3.3 JAVA方法命名规范

采用驼峰命名法,并且第一个字母小写 eg. public void searchByPage(){};

3.4 MyBatis 中xml 命名规范

  • 添加 统一名 saveXxxx
  • 编辑 统一名 updateXxxx
  • 删除 统一名 delectXxxx
  • 查找一个 统一名 findXxxx
  • 列表 统一名 searchXxxx
    专用于某一个方法的,可以直接命名 比如 我做资金回滚 我可以命名为 doRollbackMoney

四、注释

class 上面必须加注释表示这个表的作用和谁写的

method 上面也必须写方法主要用途。

interface 必须写注释 其中method必须有注释 其实现类可以不加注释

/**
* 登录,注册管理
* User: xuejianghui
* Date: 2016/6/24 15:20
*/
@Controller
@RequestMapping("/account")
public class AccountController {
/****
* 登录
* @param loginForm 验证表单
* @param result 验证结果
* @param model
* @return
*/
@RequestMapping(value = "/login", method = RequestMethod.POST)
public String login(@Valid LoginForm loginForm, BindingResult result,ModelMap model) {
BeanMap map = BeanMap.create(loginForm);
if (result.hasErrors()) {
return "index";
}
return "index";
}
}