日常开发规范

xincen_cn

已于 2024-03-21 10:30:43 修改

阅读量994

点赞数 26

分类专栏：开发工具文章标签：个人开发学习方法 java

于 2024-01-11 16:29:33 首次发布

本文链接：https://blog.csdn.net/xincen9/article/details/135532866

版权

开发工具专栏收录该内容

8 篇文章 0 订阅

订阅专栏

开发规范简录

JAVA代码规范
Mysql 规范

JAVA代码规范

项目命名：project-task

1、结构命名：
类—结尾处表明 Service \ PO\ Mapper\ xxxFactory

方法—头处表明：get list remove modify count

2、不要有魔法值，要自己定义常量类，如—CacheConsts
2.1 一般定义 interface 接口，其中定义常量默认为 public final static
3.1 命名规则，一般为大写+下划线命名

String DB_NAME = "local";

3、Object类之间的比较，使用Objects.equals

4、包装类比较全部使用equals 包括Integer

5、POJO中的类型强制使用包装类（int—>integer）

POJO类中不要设置任何默认值

6、【强制】不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator
方式，如果并发操作，需要对 Iterator 对象加锁。
如：

 List list = new ArrayList<>(); 
list.add("1"); 
list.add("2"); 
Iterator iterator = list.iterator(); 
while (iterator.hasNext()) { 
String item = iterator.next(); 
if (删除元素的条件) { 
iterator.remove(); 
} 
}

使用HashMap推荐初始设置init值，如果不确定需要用到多少推荐16 new HashMap(16);
如果是 JDK8 的应用，可以使用 Instant 代替 Date，LocalDateTime 代替 Calendar，
DateTimeFormatter 代替 SimpleDateFormat，官方给出的解释：simple beautiful strong
immutable thread-safe。
if（）{}else{} 一定要避免3层，过高推荐其他方式。

注释规范

类、类属性、类方法必须使用/** **/ 枚举必须要有注释

接口规范

遵守restful风格
声明：@RequestMapping(“/pc/commodity”) == @RequestMapping(“pc/commodity”)，两种写发是一致的，容器默认在启动时候，没有/ 路径会自动加上
类接口路径

@RestController
@RequestMapping("/pc/commodity")
public class CommodityController {
}

1、Get 单条推荐直接路径接参

	@GetMapping("{id}")
    public ResultResponse<CommodityVO> get(@PathVariable Long id) {
        return new ResultResponse<>(commodityService.get(id));
    }
  	//多条  
  	@GetMapping("list")
    public ResultResponse<PageInfo<CommodityVO>> list(CommodityQuery query) {
        PageInfo<CommodityVO> commodityPage = commodityService.list(query);
        return new ResultResponse<>(commodityPage);
    }

2、Post body传参，隐式传参

	@PostMapping
    public ResultResponse<?> save(@RequestBody CommodityForm form) {
        commodityService.save(form);
        return ResultResponse.SUCCESS;
    }

3、Put

@PutMapping("{id}")
    public ResultResponse<?> edit(@RequestBody CommodityForm form, @PathVariable Long id) {
        commodityService.edit(id, form);
        return ResultResponse.SUCCESS;
    }

4、Delete 推荐直接路径接参

	@DeleteMapping("{id}")
    public ResultResponse<?> remove(@PathVariable Long id) {
        commodityService.removeById(id);
        return ResultResponse.SUCCESS;
    }

5、其他接口，多个不可分割的单词，使用中划线拼接

	@PostMapping("commodity/check-code")
    public ResultResponse<PageInfo<CommodityVO>> checkCode(@RequestBody CommodityQuery query){
        PageInfo<CommodityVO> commodityPage = commodityService.list(query);
        return new ResultResponse<>(commodityPage);
    }