java 规范

---

时间: 2018-12-11
作者:yin_qingqin@163.com

JAVA 规范

• 变量命名，采用驼峰命名

  eg: userList、userMap、user、count、groupTitle等

  如变量是List集合，则后缀应跟上该集合类型

  List<String> tempList = new ArrayList<String>();
  Set<String> tempSet = new HashSet<String>();
  Map<String, Object> tempMap = new HashMap<String, Object>();
  

  如果是静态常量，则采用全大写方式

  public static String TOKEN = "token";
  public static String ACCESS = "access";
  

  注意：禁止出现不明变量命名，全缩写变量命名，如以下情况

  String abc = "123"; //变量命名应有具体含义
  
  CrisisRoom cr = new CrisisRoom(); //cr 命名含义不清，规范命名：CrisisRoom crisisRoom = new CrisisRoom();
  

• 方法/接口命名统一采用驼峰命名

  eg: queryUserList、getUser、addUser、updateUser、deleteUser

  查询方法命名规则,命名关键字(query、get、find)：

  // 查询信息存在多个，且不明确具体查询什么时，采用：query + 自定义 + List 方式命名；常用场景为：查询表格、查询所有表数据等情况
  
  queryUserList、queryStudentList
  
  // 查询信息为单个对象，且已知具体查询什么时,采用：get/find + 自定义(表) + By(可选) + 条件(可选)
  
  getCount
  findTree
  getUserList
  getUserListByName
  getStudentByCode
  findUserByName
  

  新增方法命名规则，命名关键字(add、save、create):

  // 命名规则: 命名关键字 + 自定义
  saveUser
  createStudent
  

  修改方法命名规则，命名关键字(update、edit):

  // 命名规则: 命名关键字 + 自定义 + By(可选) + 条件(可选)
  updateUser
  editUserByName
  

  删除方法命名规则，命名关键字(delete):

  // 命名规则: 命名关键字 + 自定义
  deleteUser
  

• swagger 接口文档注释用法

  • ctrl类上加上注解

    @Api(value = "账号信息",tags = "账号信息")
    public class AccountCtrl {	
    

  • ctrl新增注解-有参

    @WPermission(menu=MenuConstant.account, name="获取账号列表")
    @Log("获取账号列表")
    @RequestMapping(value="/queryAccountList", method = RequestMethod.GET)
    @ResponseBody
    @ApiOperation(value = "获取账号列表",notes = "分页获取账号列表，用于后台表格展示")
    @ApiImplicitParams({
       @ApiImplicitParam(name = "page", value="页数", dataType = "Integer", required = true, paramType="query"),
       @ApiImplicitParam(name = "size", value="每页显示条数", dataType = "Integer", required = true, paramType="query"),
       @ApiImplicitParam(name = "username", value="账号", dataType = "String", required = true, paramType="query"),
       @ApiImplicitParam(name = "nickName", value="昵称", dataType = "String", required = true, paramType="query"),
       @ApiImplicitParam(name = "isAvailable", value="是否可用 0.可用  1.不可用", dataType = "String", required = true, paramType="query")
    })
    public ResultPage queryAccountList(int page, int size, String username, String nickName, String isAvailable) {
       return accountSvc.queryAccountList(page, size, username, nickName, isAvailable);
    }
    

  • ctrl新增注解-无参

    @WPermission(menu=MenuConstant.account, name="获取账号集合-下拉框")
    @Log("获取账号集合-下拉框")
    @RequestMapping(value="/getAccountList", method = RequestMethod.GET)
    @ResponseBody
    @ApiOperation(value = "获取账号集合-下拉框",notes = "获取账号集合用于下拉框")
    public Result getAccountList(){
       return accountSvc.getAccountList();
    }