文档章节

命名规范

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
深圳
架构师
私信 提问
数据库设计规范

在这里总结一点吧,方便以后的使用 代码数据库设计规范 数据库表命名规范 此规范包括表名命名规范,索引命名规范,外键命名规范和字段名命名规范。 表名命名规则 数据库表的命名以是名词的复...

陈招林
2010/04/06
199
0
Android:你不能忽略的代码命名规范

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

Carson_Ho
08/08
0
0
转一个J2EE开发时的包命名规则,养成良好的开发习惯

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

绝艳天纵
2012/04/12
0
0
Android技术积累:开发规范

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

Keegan小钢
2015/11/03
663
2
技术交流

代码注释、命名规范 代码目录结构定义 数据库表名命名规范 接口签名规则定义 基本工具类的封装 开发工具定义 restful规范定义,接口规范定义 代码git管理规范,分支命名规范

霍保冲
2016/04/28
2
0

没有更多内容

加载失败,请刷新页面

加载更多

自定义 Maven 的 repositories

有时,应用中需要一些比较新的依赖,而这些依赖并没有正式发布,还是处于milestone或者是snapshot阶段,并不能从中央仓库或者镜像站上下载到。此时,就需要 自定义Maven的<repositories>。 ...

waylau
49分钟前
1
0
徒手写一个es6代码库

mkdir democd demonpm initnpm install -g babelnpm install -g babel-clinpm install --save-dev babel-preset-es2015-node5 在项目目录创建两个文件夹 functional-playground ......

lilugirl
49分钟前
2
0
linux定位应用问题的一些常用命令,特别针对内存和线程分析的dump命令

1.jps找出进程号,找到对应的进程号后面才好继续操作 2.linux查看进程详细信息 ps -ef | grep 进程ID 3. dump内存信息 Jmap -dump:format=b,file=YYMMddhhmm.dump pid 4.top查看cpu占用信息 ...

noob_chr
50分钟前
1
0
Android TV开发-按键焦点

写在前面 按键焦点过程了解 2.1 dispatchKeyEvent 过程了解 2.2 焦点查找请求过程了解 1.2.1 第一次获取焦点 1.2.3 按键焦点 焦点控制 焦点记忆 应用场景 参考资料 [TOC] 1. 写在前面 工...

冰雪情缘l
50分钟前
1
0
java框架学习日志-3

这章主要是补充一些ioc创建对象的方式,ioc容器在写好<bean></bean>的时候就已经创建对象了。在之前的例子中,一直都是无参的构造方法。下面给出有参的构造方法的对象的创建,没有什么难点重...

白话
52分钟前
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部