没有合适的资源?快使用搜索试试~ 我知道了~
java编码规范java编码规范.docx
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 73 浏览量
2022-06-10
12:17:03
上传
评论
收藏 238KB DOCX 举报
温馨提示
试读
43页
java编码规范java编码规范
资源推荐
资源详情
资源评论
编码规范
航天数联
前言
第 章 概述
第 章 重要规范
第 章 类的编写规范
第 章 航天数联编程格式规范(一)
版权信息
!"#$%&'()
*))
*))+$"*)
, 存取方法(类的设置与获取成员函数)
- 构造函数
. 克隆方法
/ 类方法 (类的普通成员函数)
0 (&)('$1!方法
2 %$1方法
第 , 章 航天数联编程格式规范(二)
,简单叙述
,复合叙述
,叙述
,3453545叙述
,,叙述
,-65叙述
,.465叙述
,/67叙述
,08477叙述
,2航天数联 69批注叙述
第 - 章 命名规范
- 一般概念
- 示范
第 . 章 注释规范
. 一般概念
. 示范
. 注释哪些部分
第 / 章 航天数联编程实践说明规范
第 0 章 设计模式快速参考
第 2 章 单元测试
第 章 互相 779 代码
第 章 代码重构
前 言
航天数联
本标准系航天数联公司首次发布实施,主要针对公司所有软件产品源代码范围的
编码风格,对 文件的文件组织、代码风格、注释、命名、声明、异常、习惯
等方面均作出规范,以保障公司项目代码的易维护性和编码安全性。
本标准由 $( 研发部门制定。
本标准起草人: 李新春
本标准主要审核人:
本标准批准人:
本标准首次发布日期:
第 1 章 概述
1.1 代码需要规范
代码之于程序员,就像零件之于机械工,庄稼之于农民,它是软件的基石,一行行
代码都是程序员的心血经过日日夜夜凝结成的。做为一个程序员, 应该像母亲呵护孩子
一样呵护自己的代码,它不仅仅是一行一行的文字,它 是一个程序员的尊严和价值所在;
它是活的,你甚至能感受到它的心跳。编 码规范只是大家达成一致的约定,这样大家的
代码就可以互相看懂,维护起 来更加容易,思想更畅快的交流,经验更快的得到传播。
代码规范不是束缚 程序员的桎梏,应该知道,不遵守规范的个性的代码并不代表程序员
的性格, 并不能张扬个性。个性应该体现在用更简单、更优雅、更易读、更易理解以
及算法实现效率更高等方面。
可读性,可理解性是代码的重要方面,本规范主要围绕如何去产生规范 易读的代码。
另外,它也保证了大家有共同的先验知识。
第 2 章 重要规范
一 操作规范
模板及格式化
航天数联
航空数联开发人员必须保证代码格式化的一致性,否则可能会导致代码冲突,
轻微的耗费人力合并代码;严重时可能导致代码丢失,引起 : 或者故障。
开发人员必须配置 16 的 :;747<== 代码模板文件。
开发人员必须配置 16> 的 =4747<5 代码格式化文件。
每次提交代码之前,必须对 ? 代码 &'7。
模板文件:
"75= 中配置的位置:
#6946:#7##7#7<#:;747<==
#6946:#7##7#=#=4747<5
代码提交
为防止冲突,任何时候,代码(及配置文件)提交前,先从 )1
中更新代码和配置文件,以及早发现丌兼容的代码变更和冲突。
提交代码(及配置文件)时,如果发生冲突时,先看历史说明,再找相
关人员确认,坚决不允许强制覆盖。
每次提交代码之前,必须检查是否有 75=6,并 +$@ 所有
的 6。
开发过程定期使用 +> 扫描代码,合并代码时不允许出现高等级
问题。
3. 垃圾清理
. 对从来没有用到的或者被注释的方法,变量,类,配置文件,动态
配置属性等要坚决从系统中清理出去,避免造成过多垃圾。
二 日志规范
日志输出
生产代码禁止以 )8 及 (6:5=)79(7 的方式输
出日志信息,必须用 * 替代。
对 7#:# 级别的日志输出,必须使用条件输出形式,否
则大量的日志会增加来自对象 ) 的性能成本。
对于日志的打印,任何情冴下都不允许日志错误导致业务失败。
2. 错误日志
. 对于由于系统原因造成业务处理失败的事件,需要记录错误日志。非系统
航天数联
原因的业务处理失败,不应该记录错误日志(推荐使用 warn 级别),避免
错误日志过大,影响紧急情况下的故障分析不诊断.
三 注释规范
基本原则
对于一个完整的类,应该包括 167 的版权注释、类的说明注释、类
成员变量注释,以及 =:57、=7、= 方法的注释
(A、A、接口的实现方法除外)。
必须保证代码和注释的一致性。
正确区分使用文档注释和实现逻辑注释。
四 异常处理
捕捉到的异常,不允许不做任何处理就截断,至少要记入日志,或重新
抛出。
最外层的业务使用者,必须处理异常,将其转化为用户可以理解的内容
五 安全规范
B">C安全
对于前台的 6:C页面,必须加上表单防重复提交功能;对于业务关键字段需
要加上防篡改的功能,否则可能造成业务重复执行或者被客户端恶
意修改。
对于前台的 6:C页面,严禁出现方便调试的后门页面。
不允许出现页面向自身重定向、或者多个页面间相互重定向的情冴。如
果控制不当,很容易造成系统宕机。
敏感信息的保护
D用户的敏感信息包括密码、短信验证码、支付验证码、身份证号、银行卡号、
银行密钥,商户密钥等信息;用户敏感信息不能泄露,否则可能会带来不安全因
素。可能会导致敏感信息泄露的方式有:Logger、URL 的 get 参数(因为 URL 的
get 参数会在 apache 日志中被输出) 。
六 通用规范
1. 配置信息的使用
避免将 UserID、URL、文件名、系统开关参数、业务规则的可变参数等硬编码。
2. 资源的使用
对系统资源的访问,使用后必须释放系统资源。这类资源包括:文件流、线程、
航天数联
网络连接、数据库连接等。
对于文件、流的 IO 操作,必须通过 nally 关闭。
对于线程,线程资源必须通过线程池提供,不允许在应用中自行显式创建线程。
对于网络连接与数据库连接,必须由框架通过连接池提供,不允许应用中自行
建立网络与数据库连接。
第 3 章 类的编写规范
1) 所有包,类,接口,方法,属性,变量,参数均使用英文单词进行命名,具
体细节请参见命名规范一章。
2) 命名包,类,接口,方法以及变量时,尽量使用贴近问题域的且意义丰富的名
称。
3) 修改源代码时,应尽量保持与所修改系统的编码风格保持一致。
4) 所 有 包 名 使 用 必 须 使 用 com.[company] 前 缀 , 所 有 项 目 使 用 com.
[company].projects.[project name], company 是 公 司 简 称 ,
project name 是项目的缩写。
注意尽量不要用生僻的缩写,尤其是中文缩写。
附上例子:可以点击查看
第 4 章 航天数联编程格式规范(一)
所有的 E?文件都必须遵守如下的样式规则:
航天数联
剩余42页未读,继续阅读
资源评论
oligaga
- 粉丝: 52
- 资源: 2万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功