Java代码规范

  • 一个方法不超过二十行 60

  • 抛异常

    如果catch了异常,log一般打印成error级别

    如果msg参数使用了占位符{}的情况,在已经传入了占位符所需要的参数之后,可以再额外传入一个exception,就能正常打印出堆栈信息

    try{
       ...
    }catch(Exception e){
     log.error("failed for dto {}",dto, e)
    }   

        如果重新抛出,重新抛出的异常必须带上原异常,否则到时报错了看不到原异常。

try{
    ...
}catch(Exception e){
     throw new RuntimeExcetion("there is a error", e)
}              

  • 代码添加适当的日志(方便debug)
log.info("searchValue -> resp:{}", resp.getValue());

在每个方法开头加日志方便查是否进入该方法

private BResponse edit(BRequest req) {
       log.info("edit -> req:{}", req); 
...
}

  • 提交代码前要格式化代码

    快捷键:ctrl + alt + L

  • 检查是否有代码警告(消除)

  • Url的规范

    用 - ,不能有get,方法名可以有

    Delete @GetMapping "/123/delete" 或 "/delete/123"

    超过两个id用@PostMapping body-request

    list不能写,要有复数

    方法不要超过60行

  • Eneity 的逻辑删除字段要命名为:deleted ,不能为isDeleted

    在POJO类中的任何布尔类型的变量,强制不可以用is前缀。

        boolean使用lombok编译后的set和get方法:

        方法名称如下是,setDeleted,isDeleted

        但Boolean封装类可以正常生成

  • 4
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值