文档章节

命名规范

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

#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
深圳
架构师
转一个J2EE开发时的包命名规则,养成良好的开发习惯

代码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。 代码编写规范使用范围:J2EE项目开发。 包命名规范: 目的:包的命名规范应当体现出项目资源良好的...

绝艳天纵
2012/04/12
0
0
Android:你不能忽略的代码命名规范

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

Carson_Ho
08/08
0
0
Android技术积累:开发规范

目前网上虽然也有不少讲到开发规范,但都讲得不细。我自己总结了一份比较完整的开发规范,包括统一编码方式、缩进、空格的使用、常量的定义、包和类命名、方法命名、常量命名、控件缩写、控件...

Keegan小钢
2015/11/03
651
2
软件项目质量保证:编码规范

原文出处:MeteorSeed 作为软件开发者,我们可以开发低等级的软件,但不能开发低质量的软件。所以,如何实施质量保证,是我们关注的主要问题之一,而编码规范则是实施质量保证的第一步。 编码...

MeteorSeed
2016/08/29
0
0
平台资源表 表和表字段的命名规范——JEPLUS软件快速开发平台

JEPLUS平台资源表和表字段的命名规范 规范性的东西其实都是约定俗成的,你不按规范来写并非不可以,但是不按照规范来写代码的可阅读性就很差,简单来说就是你看的懂我们看不懂,时间久了之后...

JEPLUS
06/13
0
0

没有更多内容

加载失败,请刷新页面

加载更多

现场看路演了!

HiBlock
9分钟前
0
0
Rabbit MQ基本概念介绍

RabbitMQ介绍 • RabbitMQ是一个消息中间件,是一个很好用的消息队列框架。 • ConnectionFactory、Connection、Channel都是RabbitMQ对外提供的API中最基本的对象。Connection是RabbitMQ的s...

寰宇01
26分钟前
1
0
官方精简版Windows10:微软自己都看不过去了

微软宣布,该公司正在寻求解决方案,以减轻企业客户的Windows 10规模。该公司声称,企业客户下载整个Windows 10文件以更新设备既费钱又费时。 微软宣布,该公司正在寻求解决方案,以减轻企业...

linux-tao
31分钟前
0
0
TypeScript基础入门之JSX(二)

转发 TypeScript基础入门之JSX(二) 属性类型检查 键入检查属性的第一步是确定元素属性类型。 内在元素和基于价值的元素之间略有不同。 对于内部元素,它是JSX.IntrinsicElements上的属性类型...

durban
今天
1
0
AVA中CAS-ABA的问题解决方案AtomicStampedReference

了解CAS(Compare-And-Swap) CAS即对比交换,它在保证数据原子性的前提下尽可能的减少了锁的使用,很多编程语言或者系统实现上都大量的使用了CAS。 JAVA中CAS的实现 JAVA中的cas主要使用的是...

码代码的小司机
今天
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部