SN_T 4899-2017检验检疫信息系统JAVA编码规范.pdf

SN中华人民共和国出入境检验检疫行业标准SN/T 4899—2017检验检疫信息系统Java编码规范Java code specifications of inspection and quarantine information systems2017-08-29发布2018-04-01实施中华人民共和国发布国家质量监督检验检疫总局 SN/T 4899—2017前言本标准按照GB/T1.1一2009给出的规则起草。本标准由国家认证认可监督管理委员会提出并归口。本标准起草单位：国家质量监督检验检疫总局信息中心、珠海出入境检验检疫局、浙江出人境检验检疫局。本标准主要起草人：李可、余军阳、张琦、莫健斌1 SN/T 4899—2017检验检疫信息系统Java编码规范1范围本标准规定了检验检疫信息系统采用Java语言编码需遵循的基本内容。基本内容包括文件、文件组织、排版、注释、声明、命名规范本标准适用于指导检验检疫机构和为检验检疫机构设计开发检验检疫信息系统的单位开展编码工作，也适用于作为检验检疫机构验收参考依据2规范性引用文件下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T5271.15—2008信息技术第15部分：编程语言3术语和定义GB/T5271.15—2008界定的术语和定义适用于本文件4检验检疫信息系统编码规范4.1文件4.1.1文件名检验检疫信息系统文件名应采用如表1所的后缀表1文件后缀文件类别文件后缀Java源文件javaJava字节码文件.classJSP文件jspXML文件.xml资源文件.properties日志文件.logTag lib文件.tlbJava包文件.jar层叠样式表文件.css SN/T4899—20174.1.2类文件类文件编译应采用混淆编译等措施加强代码安全。4.2文件组织4.2.1包声明包声明应作为第一行非注释行，指明包含当前类文件的包名。4.2.2类引进类引进应在包声明之后，标明引进类文件；专用的类先引进，公共的类后引进。4.2.3属性属性应按照修饰符排序，顺序依次为：static，public，null，protected，private。示例：private static final boolean VERBOSE=true;private EntityContext ctx;private String accountld;4.2.4方法方法应包括方法头和方法体，按照public、private顺序排列。示例：public void setEntityContext(EntityContext entityContext)(this.entityContext=entityContext;public EntityContext getEntityContext()return this.entityContext;private ListStringlog(String str,String spilt)(if(str==null//.equals(str))(return null; ;ListStringresult=str.str.split(spilt);return result;-4.3排版缩进排版单位4.3.1个缩进排版单位应为4个空格。4.3.2行长度行代码长度不能超过80个字符。4.3.3换行当一个表达式无法容纳在一行内时，应依据如下规则换行：2 SN/T4899—2017在一个逗号后面换行；在一个操作符前面换行；选择较高级别换行，而非较低级别换行；新的一行应与上一行同一级别表达式的开头处对齐。示例：getCertByld(String certld,String deleteFlag,String orgCode,String efectiveFlag);var=getCertByld(certld,getCertByld(deleteFlag,orgCode));按级别换行示例：totalAmount=month * (testFee+ sailFee-paidFee)十4*seasonFee：//合理totalAmount=month*（testFee+sailFee一paidFee）十4*seasonFee；//不合理4.3.4空行逻辑相关的代码段应采用空行分隔，提高可读性。下列情况应使用两个空行分隔：个源文件的两个片段（section）之间；类声明和接口声明之间。下列情况应使用一个空行分隔：两个方法之间；方法内的局部变量和方法的第一条语句之间；块注释或单行注释之前；个方法内的两个逻辑段之间，用以提高可读性4.3.5空格下列情况应使用空格分隔