Java项目代码规范
作者:程序员马丁
note
热门项目实战社群,收获国内众多知名公司面试青睐,近千名同学面试成功!助力你在校招或社招上拿个offer。
在实际开发过程中,不同程序员的编码风格千差万别。出于对代码整洁度的高度关注,我梳理并制定了一套适用于 Java 项目的编码规范,用以约束自身编码习惯,逐步形成清晰、统一、他人易于理解的代码风格。
该规范会持续迭代更新,以适应项目演进与团队协作的需求。
方法命名
1. 获取单个对象的方法用 get 或者 find 作前缀
例如:查询单个用户 getStudent,按照 ID 查询单个用户 getStudentById。
2. 获取多个对象的方法用 list 作前缀
例如:按照 IDS 查询多个用户,listStudentByIds。
3. 获取统计值的方法用 count 作前缀
例如:统计全量用户,countUser。
4. 插入的方法用 save 作前缀
例如:新增用户,saveUser。
5. 删除的方法用 remove 作前缀
例如:删除用户,removeUser。
6. 修改的方法用 update 作前缀
例如:修改用户,updateUser。