Java 名称命名规范

引用尚学堂所讲的

一:Java中的名称命名规范

  • 项目名:全部小写

  • 包名:所有字母都小写

    • 含Java类的包不能使用特殊字符

    • 采用反域名命名规则,全部使用小写字母。一级包名为地顶级域名如com,二级包名为xx(可以是公司或则个人的随便),三级包名根据应用进行命名,四级包名为模块名或层级名; 如 com.tinyx.myapp.activities;

      • indi :
        个体项目,指个人发起,但非自己独自完成的项目,可公开或私有项目,版权主要属于发起者。
        包名为indi.发起者名.项目名.模块名*…

      • pers :
        个人项目,指个人发起,独自完成,可分享的项目,版权主要属于个人。
        包名为pers.个人名.项目名.模块名*…

      • priv :
        私有项目,指个人发起,独自完成,非公开的私人使用的项目,版权属于个人。
        包名为priv.个人名.项目名.模块名*…

      另外,我为了区分团队项目和前面所说项目的区分,还有了一下扩展:

      • team : 团队项目指由团队发起,并由该团队开发的项目,版权属于该团队所有。 包名为team.团队名.项目名.模块名*…

      • com : 公司项目:由项目发起的公司所有。 包名为com.公司名.项目名.模块名*…

  • 类名、接口名:所有单词的首字母大写(大驼峰命名法)

  • 变量名、方法名:第一个单词首字母小写,第二个单词开始每个单词首字母大写(驼峰式命名法)

  • 常量名:所有字母都大写。单词间用下划线隔开。

说明:Java采用Unicode字符集,因此标识符也可以使用汉字声明,但是不建议使用

二:四种编程命名规范

1 Android开发命名规范(基于java命名规范)

  • 包名

    • 第一维度使用模块,第二维度是功能
    • 包名一般要求小写,并且尽量不出现下划线等字符,值得注意的是,需要用英文来命名而不是中文。例如views,widge
    • 一般是功能、模块的简写,能够让包名能够一目了然,知道这个包里面放的是什么文件。例如ui、activity等
  • 类名(要求对类进行注释!!!)

    • java类的命名首字母要求大写,采取驼峰式命名
    • java类的命名要尽量一目了然,闻其名而知其意
    • 如果是一般的接口(interface)文件,则命名为Ixxx.java,
    • 如果是监听文件的,一般是以On开头,例如:OnGetCityDataListener.java
  • java变量、方法等的命名(并且尽可能的给函数方法进行注释说明)

    • 设置全局变量和静态变量以m、s开头
  • 资源文件命名规范的重要性

    • 资源文件命名以小写字母+下划线组成,名字不怕长就怕太简略,要尽可能一眼能看出该资源文件是用来干什么的,我改怎么去找到这个文件?鉴于Android开发肯定会存在很多很多的资源,所以最好能够一个一个模块的放好、并且有明显的命名去命名,方便自己也方便他人在二次开发、bug修复和后续迭代等操作中能够更快的定位到。这个步骤很繁琐,要做好不简单,见微知著,细心耐心!

2 匈牙利命名

匈牙利命名:开头字母用变量类型的缩写,其余部分用变量的英文或英文的缩写,要求单词第一个字母大写。

int iMyAge; “i”是int类型的缩写;
char cMyName[10]; “c”是char类型的缩写;
float fManHeight; “f”是float类型的缩写;

3 驼峰式命名法

驼峰式命名法:(又叫小驼峰式命名法)第一个单词首字母小写,后面其他单词首字母大写。

int myAge;
char myName[10];
float manHeight;

4 帕斯卡命名

帕斯卡命名(又叫大驼峰式命名法)每个单词的第一个字母都大写。

int MyAge;
char MyName[10];
float ManHeight;

5 下划线命名法

下划线命名法单词与单词间用下划线做间隔

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
1. 模块命名、数据库表命名、域模型命名、各分层的类/方法命名、页面的命名; 模块命名: a. 包命名:com.project_name.module_name.action/service/dao/ws; service的实现都置于com.project_name.module_name.service.impl下; b. 接口命名遵守XxxxService,接口实现遵守XxxxServiceImpl; 2. 包的设计、页面的层次结构设计(jsp/css/js等文件的结构); 3. log、异常(声明式异常)的约定设计; 4. 链接、按钮、表单提交的统一方式;通用式Ajax调用与页面跳转统一模型; 5. 响应一个请求的分层结构约定,列举几个示例(常规调用、Ajax调用、WebService调用、提供WebService暴露、硬件设备接口调用); 6. 验证代码质量的约定,如JUnit、EMMA、FindBugs、CheckStyle、PMD的使用;Hudson持续集成需注意的; 7. 压力测试、防内存泄漏测试; 基础CSS:标签的各种状态的样式;表格单双行的样式; 开发一个Action请求的响应: 前置条件:该Action涉及的Entity及EntityName.hbm.xml已经准备好。 步骤: a. 前端页面触发Action的请求; 统一采用全路径请求,URL格式: 1> basePath/web/moduleName/*_ *.action {1}  EntityName,{2}  ActionMethodName 2> basePath/web/moduleName/gotoXxx.action (无需调用Service,直接跳转) 包括jQuery的Ajax方式和非Ajax方式; 包括表单提交; 参数设值的方式: 1> URL参数: basePath/web/moduleName/*_*.action?entity.propertyName=paramValue&paramName=paramValue 2> 或 另外,对于表单的提交,前后台都必须做数据校验,SWDF已提供了此能力,进行简单的配置即可,前台直接提供类似以下代码即可,点此查看前端校验详细规则说明。 前端校验示例; 后台数据校验,点此查看校验详细说明. b. 配置struts-moduleName.xml; 直接跳转示例; 调用Service示例; c. 开发对应的{EntityName}Action类; 该类必须继承com.hikvision.swdf.xx.BaseAction,该Action类有一个关键属性entity,即泛型Entity类的一个实体,该属性默认填充好了请求提交过来的entity对应参数(即entity.propertyName); d. 开发Service接口和Service接口实现,并在Action通过set方法注入该Service; 接口文件:UserService 接口实现:UserServiceImpl 注入Service e. 开发DAO,DAO继承com.hikvision.xxx.HibernateBaseDAO; 示例 f. 配置applicationContext-*.xml; 配置DAO bean、Service Bean、Action Bean及注入的配置; g. 测试; 备注: 1. Action建议统一遵守通配符的约定,basePath/web/moduleName/*_ *.action {1}  EntityName,{2}  ActionMethodName 2. 统一命名规则:接口类似UserService,接口实现类型UserServiceImpl;(IUserService和UserServiceImpl) 开发一个Action调用关联应用提供的WebService 前置条件:该WebService?WSDL可正常获取 步骤: a. 配置applicationContext-wsclient.xml; Spring管理第三方WebService实例bean Jaxws-client配置代码 b. 生成第三方WebService接口文件;(提供系统自动生成) 自动生成代码 c. 页面调用Action请求,Action注入WebService实例bean; Action对应方法直接调用第三方WebService的相关方法; d. 测试; 备注: 1. 步骤b,接口文件必须同包名同类名置于src目录下; 开发一个Action调用关联应用开放的HTTP请求 步骤: 1. 页面调用Action请求; 2. Action类相应方法使用封装好的HttpClient相关工具类,准备好HTTP请求的相关参数header参数和body参数并以xml的方式提交HTTP请求; 3. 解析该HTTP请求返回值(XML或JSON); 4. 响应结果; 5. 测试; 备注: 开发一个需要对第三方应用发布的WebService 步骤: a. 开发WebService接口,@WebService进行注解该接口; b. 开发WebService接口实现类,@WebService注解该实现类,并制定endpointInterface; c. 配置applicationContext-ws.xml d. 测试 备注: 开发一个需要对第三方应用发布的RESTful Service 步骤: a. 开发RS接口,提供如下Annotation; b. 开发RS接口实现,并提供如下Annotation; c. 配置applicationContext-rs.xml 备注: 所有Annotation的涵义解释如下:
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值