前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >Java项目命名规范要求

Java项目命名规范要求

原创
作者头像
用户8983410
修改2021-10-08 14:55:55
修改2021-10-08 14:55:55
2K0
举报
  • 项目名:全部小写
  • Package 的命名:应该都是由一个小写单词组成
  • Class 的命名:首字母大写的驼峰式命名,即FirstName
  • 变量和方法的命名:首字母小写的驼峰式命名,即firstName
  • 当要区别接口类和实现类的时候,可以在类的后面加上“Impl”。 如:接口类:UserInterface.java 接口实现类:UserInterfaceImp
  • Static Final 常量的命名:大写下划线形式,即FIRST_NAME
  • 在Spring Boot的配置文件application.yml或application.properties中,推荐:first-name
  • 在数据库的列中,推荐:first_name
  • jsp,Velocity等页面采用小写的英文字符和”_ ”组成,整体采用模块名+操作的形式。如:user_view.jsp。
  • xml配置文件很多用_.xml的方式,但我看的项目却用mybatis-config.xml,所以暂时不统一。

名称只能由字母、数字、下划线、$符号组成,不要用拼音命名 应用系统中经常应用分层,Dao层(数据库访问)、Service层(业务处理)、Web层(页面控制action类),每一层的类的名称尽量带上该层后缀。 推荐实体类没有后缀名。 比如:

Dao层

a、接口类:采用JavaBean+Interface+Dao的形式来定义,即,实体对象+Interface+Dao。 如:用户对象接口类: UserInterfaceDao,其中xxx为模块名称。 b、实现类:采用JavaBean+Interface+Impl+Dao的形式来定义,即,实体对象 +Interface+Impl+Dao。 如:用户对象实现类:UserInterfaceImplDao 若没有Interface,则省略

Service层

a、接口类:采用Xxx+Interface+Service的形式来定义,即,模块+Interface+Service。 如:用户管理接口类:UserMsgInterfaceService b、实现类:采用Xxx+Interface+Impl+Service的形式来定义,即,模块+Interface+Impl+Service。如:用户管理实现类:UserMsgInterfaceImplServce

变量命名实际应用

变量命名采用基本结构为typeVariableName,使用3字符前缀来表示数据类型。 例如,定义一个整形变量:intDocCount,其中int表明数据类型,后面为表意的英文名,每个单词首字母大写。

数据类型或对象类型

变量前缀

备注

byte

bye

1、做数组用时,再加前缀-a,如字符串数组:astr,

char

chr

2、自定义类型的变量可以采用本身的名称,把首字母改为小写。

float

flt

3、采用名称要能代表在方法中的意义。如果员工列表:employeeList

boolean

bln

Integer/int

int

short

sht

Long/long

lng

Double/double

dbl

string

str

如果需要对变量名进行缩写时,一定要注意整个代码中缩写规则的一致性。例如,如果在代码的某些区域中使用intCnt,而在另一些区域中又使用intCount,就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。

数据层方法:只能以insert(插入),delete(删除),update(更新),select(查找),count(统计)开头,其他层方法避免以这个5个单词开头,以免造成误解。

服务层方法,根据方法的行为命名,只描述方法的意义,而不采用方法的目的命名。比如系统的添加新用户,用户可以前台注册,也可以管理员后台添加,方法会被重用,所以最好不要用使用register,采用add会更好写。避免使用与web层相关的方法。

Web层方法最好是贴近web的语言,如register,login,logout等方法。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • Dao层
  • Service层
  • 变量命名实际应用
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档