文档章节

命名规范

Jnoee
 Jnoee
发布于 2015/02/23 22:50
字数 653
阅读 48
收藏 0

码上生花,ECharts 作品展示赛正式启动!>>>

#1. Entity ##1.1. 类名 应尽可能使用简短的英文单词或组合单词,采用标准Java命名方法,例如:User、UserSettings。 ##1.2. 属性、变量 名词或组合名词,List和Map常加个s来表示。应避免简写,采用完整写法来表达清楚的意思。

正面示例:

private String name;
private String username;
private String password;
private Organ organ;
private List<Actor> actors = new ArrayList<>();
private Integer collectRecordCount = 0;

反面示例:

private String n;
private String uName;
private String pwd;
private Organ org;
private List<Actor> aList = new ArrayList<>();
private Integer crc = 0;

#2. Service ##2.1. 类名 通常一个Entity对应一个Service,命名格式:Entity类名+Service。例如:UserService、UserSettingsService。 ##2.2. 方法名 动词+[名词或组合名词]。常用方法名示例:

  • 分页查找用户:public Page<User> findUser(SearchModel searchModel) {...}
  • 分页搜索用户:public Page<User> searchUser(SearchModel searchModel) {...}
  • 获取所有用户:public List<User> getAllUser() {...}
  • 获取指定ID的用户:public User getUser(String userId) {...}
  • 获取指定用户名的用户:public User getUserByUsername(String username) {...}
  • 新增用户:public void createUser(User user) {...}
  • 更新用户:public void updateUser(User user) {...}
  • 删除用户:public void deleteUser(User user) {...}
  • 禁用用户:public void disableUser(User user) {...}
  • 启用用户:public void enableUser(User user) {...}

#3. Action ##3.1. 类名 通常一个Entity对应一个Action,命名格式:Entity类名+Action。例如:UserAction、UserSettingsAction。 ##3.2. 方法名 动词 或 动词+[名词或组合名词]。常用方法名示例:

  • 查看用户列表:public void list(Model model,SearchModel searchModel) {...}
  • 查看用户:public void view(Model model,User user) {...}
  • 新增用户(打开新增用户页面):public void add(Model model) {...}
  • 保存用户(提交新增用户表单):public ModelAndView save(User user) {...}
  • 编辑用户(打开编辑用户页面):public void edit(Model model,User user) {...}
  • 更新用户(提交编辑用户表单):public ModelAndView update(User user) {...}
  • 删除用户:public ModelAndView delete(User user) {...}
  • 禁用用户:public ModelAndView disable(User user) {...}
  • 启用用户:public ModelAndView enable(User user) {...}

#4. Page Entity类名-动词。常用页面名示例:

  • 用户列表页面:user-list.ftl
  • 查看用户页面:user-view.ftl
  • 新增用户页面:user-add.ftl
  • 编辑用户页面:user-edit.ftl

#5. DB

  • 表名:项目简写名_Entity类名。例如:XXX_UserXXX_UserSettings
  • 字段:跟Entity属性名保持一致,采用驼峰式命名规则。
  • 主键:PK_Entity类名_主键字段名。例如:PK_User_idPK_UserSettings_id
  • 外键:FK_Entity类名_外键字段名。例如:FK_User_organIdFK_UserSettings_userId
  • 索引名:IDX_Entity类名_索引字段名。例如:IDX_User_usernameIDX_UserSettings_userId

© 著作权归作者所有

Jnoee
粉丝 4
博文 8
码字总数 5282
作品 0
深圳
架构师
私信 提问
加载中
请先登录后再评论。
C/C++命名规范-C语言基础

这一篇文章想要介绍的是编写代码的时候业界比较常用的一些命名规范,以及个人平时的一些命名规范。涉及“”、“”、“”、“”的介绍和见解。属于C语言基础篇() 刚刚开始学习编程的时候,我...

osc_51w4wn2j
2019/01/29
1
0
Android:你不能忽略的代码命名规范

前言 Android代码规范内容非常多,但对我们最有用& 最有影响的莫过于 Android代码的命名规范 可是,有很多人容易忽略代码的命名规范,从而导致代码的可读性 & 维护性非常差,最终导致开发效率...

Carson_Ho
2018/08/08
0
0
Vue项目中的文件/文件夹命名规范

Vue项目中的文件/文件夹命名规范 0.2262018.09.21 16:01:09字数 820阅读 6979 文件或文件夹的命名遵循以下原则: 或者 ,统一使用小写字母开头的()命名规范 属于或的,统一使用大写字母开头的...

osc_p0ka0957
2019/09/08
8
0
【PHP开发规范】老生常谈的编码开发规范你懂多少?

【PHP开发规范】老生常谈的编码开发规范你懂多少? 这几天看了一下阿里技术发布的一套Java开发规范《阿里巴巴Java开发手册》,里面写了阿里内部的Java开发规范标准,写的很好。这套Java统一规...

osc_mnd6q2ay
2019/03/24
2
0
JAVA 增删改查接口命名规范(dao层与 service 层

开发时,有很多规范,这里写的是命名规范。 本页展示阿里和网络上两种不错规范备用 1: 阿里支命名规范 2:感觉也不错规范 Dao 接口命名 insert batchInsert selectOne selectById count sele...

osc_op3x65ho
01/18
5
0

没有更多内容

加载失败,请刷新页面

加载更多

UltraEdit for Mac 20.00.0.32 文本编辑器

MacOS上最受欢迎的文本编辑器是哪款?UltraEdit Mac版支HTML、PHP、Perl、Java 和 JavaScript 等众多流行计算机高级语言的程序编辑器,Ultraedit与Notepad ++相比。你可以直接用它来修改exe...

麦克W
26分钟前
10
0
java垃圾回收机制的理解

Java垃圾回收机制算法 标记----清除算法 复制算法 标记----整理算法 分代收集算法 为什么要进行垃圾回收 因为当一个对象的引用不可达,或者一个对象没有任何引用指向它,那么它就没有必要在内...

RandomObject
39分钟前
13
0
Java集合常见面试题

Java集合框架 集合框架底层数据结构总结 Arraylist 与 LinkedList 异同 是否保证线程安全: ArrayList 和 LinkedList 都是不同步的,也就是不保证线程安全; 底层数据结构: Arraylist 底层使...

JaneRoad
42分钟前
18
0
Makefile中.PHONY的作用是什么? - What is the purpose of .PHONY in a makefile?

问题: What does .PHONY mean in a Makefile? .PHONY在Makefile中是什么意思? I have gone through this , but it is too complicated. 我已经经历过了 ,但是它太复杂了。 Can somebody e......

法国红酒甜
47分钟前
15
0
看了同事的代码,我忍不住写了这份代码指南

❝ 作者:xybaby 链接:https://www.cnblogs.com/xybaby/p/11335829.html ❞ 前言 写出整洁的代码,是每个程序员的追求。《clean code》指出,要想写出好的代码,首先得知道什么是肮脏代码、...

osc_fvp5wdwk
今天
24
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部