命名规范
博客专区 > Jnoee 的博客 > 博客详情
命名规范
Jnoee 发表于3年前
命名规范
  • 发表于 3年前
  • 阅读 43
  • 收藏 0
  • 点赞 0
  • 评论 0

【腾讯云】如何购买服务器最划算?>>>   

摘要: 好的命名规范将会使得项目的代码更易理解和维护,本章规定了开发过程中常用的命名规范,包括Entity、Service、Action、Page、DB命名规范,它们之间通过约定的命名可以快速找到各自关联的对象。

#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
共有 人打赏支持
粉丝 4
博文 8
码字总数 5282
×
Jnoee
如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!
* 金额(元)
¥1 ¥5 ¥10 ¥20 其他金额
打赏人
留言
* 支付类型
微信扫码支付
打赏金额:
已支付成功
打赏金额: