阿里巴巴代码规范(一)

一.编程规约

1.命名风格‘

  1.代码中的命名不能以下划线或美元符号开始 也不能以下划线或者美元符号结束;

  2.代码中的命名不能是拼音或者英文混合,尽量不要使用纯拼音

  3.类名驼峰原则 UserManagerServiceImpl (第一个word首字母大写)

  4.方法驼峰原则 addUserInfo(第一个word首字母小写)

  5.常量名全部大写 单词之间用_隔开

  6.抽象类 使用 Abstract 和 Base 开头  异常类使用Exception结尾 测试类以测试的类的名字为开头 以Test为结尾

  7.数组定义 String[] args

  8.POJO类 及普通的Java beans 中的布尔型常量 定义的时候 命名不要以is开头 例如isSure等

  9.包名统一使用 小写 点分隔符之间有且仅有一个自然语义的英语单词 ,包名统一使用单数形式 但如果类名中存在复数含义 类名可以使用复数形式

  10.杜绝 完全不规范的缩写 例如 Contribution  缩写成Cont

  11.为了保证代码良好的可阅性 尽可能使用完整的单词来表达其意

  12.如果模块 接口 类 中使用了设计模式 应该在命名中体现设计模式 提高可阅性

  13.接口类的方法和属性 不要添加任何 修饰符号 (public也不要加)保持代码的简洁性 加上有效的java doc 注释 ,尽量不要在接口中定义变量  如果必须 则一定是与接口方法有关  且一定跟整个应用有关

  14.接口和实现类

    1.强制 对于Service 和 Dao类 基于SOA(面向服务架构)的理念  暴露出来的一定是接口 内部的实现类 用Impl的后缀 与接口区别

    2.如果是形容能力的接口名称 取对应的形容词做接口名(通常是able形式) 如AbstractTranslator实现 TransLatable

  15.枚举类名建议加上 Enum后缀  枚举成员名称 需要全大写 单词间用下划线 隔开

  16.Service/Dao层方法命名公约

    A. Service/Dao层

      1.获取单个对象用 get做前缀

      2.获取多个对象用list做前缀

      3.获取统计值用count做前缀

      4.插入的方法用save/insert做前缀

      5.删除的方法用remove/delete做前缀

      6.修改的方法用update做前缀

    B.领域模型命名规约

      1.数据对象: xxxDO xxx一般为数据表名

      2.数据传输对象:  xxxDTO xxx为业务相关领域的名称

      3.展示对象:xxxVO xxx一般为网页名称

      4.POJO是DO/DTO/BO/VO的统称 禁止命名为 xxxPOJO 

  

  

原文地址:https://www.cnblogs.com/frankzone/p/11586074.html

时间: 2024-10-09 23:44:16

阿里巴巴代码规范(一)的相关文章

IDEA 阿里巴巴代码规范检查插件

1.问题概要 大家都想写出规范的代码,可规范的标准是什么勒,估计每个人心中的标准都不是完全一致的 在分工合作越来越精细化的时代,我们需要一个最大程度接近公认的规范,这里我们以阿里巴巴的代码规范作为参考, 主要包括两部分 一.阿里巴巴代码规范插件的使用,在代码中就直接提示你不规范的代码 二.<<阿里巴巴 java开发手册>>,该书详尽的讲述了开发的中的规范 2.如何安装与使用:阿里巴巴代码规范插件 点击安装后,重启idea生效 生效后在有不规范的代码处,会有黄色的警告线提示,并且给出

这篇文章不错——代码规范

该文章来自于阿里巴巴技术协会(ATA)精选文章. 个人经历 对我代码质量影响最大的是在一家外资企业,在这家公司我觉得有以下几个方面做的很不错. 团队编码风格统一 统一到什么程度? 不看代码作者,你很难区分代码是谁写的(在目前公司一些团队也能达到这个标准). 个人观点: 这样做有什么好处?团队中每个人阅读代码都很容易,减少很多沟通,维护成本( 代码阅读的次数远远大于变更的次数),并且心情非常愉悦.有人肯定觉得愉悦有点夸张,举个栗子: 有一些代码,如果不是由于与工作内容有关联,你是否有种这辈子都不情

解读阿里官方代码规范

2017年开春,阿里对外公布了「阿里巴巴Java开发手册」.作为一个13年经验的码农,从头到尾浏览了一遍这份手册之后,感觉很棒.虽然其中的某些观点笔者不能苟同,但大部分的规范还是值得绝大多数程序员学习和遵守的. 笔者将对这份代码规范中的一些细节做一些解读,包含笔者的观点和想法,可以作为这份代码规范的扩展阅读.对于规范中某些「显而易见」的条款,将不在解读范围之列(换言之,这都不懂,就说明你天赋不够,乘早别做程序员了). 当然,笔者在日常的编程过程中属于「代码洁癖偏执狂」,所以文中的某些观点仅代表个

MyEclipse中阿里JAVA代码规范插件(P3C)的安装及使用

JAVA代码规范插件(P3C)是阿里巴巴2017年10月14日在杭州云栖大会上首发的,使之前的阿里巴巴JAVA开发手册正式以插件形式公开走向业界.插件的相关信息及安装包都可以在GitHub(https://github.com/alibaba/p3c)上获取.目前插件实现了开发手册中的53条规则,只能满足较为基本的代码检测,后继应该会更加完善. MyEclipse中阿里JAVA代码规范插件(P3C)的安装跟通常的插件安装方法相同,有三种方法. 安装方法: 方法一.MyEclipse中在线安装 1

好代码是管出来的——C#的代码规范

代码是软件开发过程的产物,代码的作用是通过编译器编译后运行,达到预期的效果(功能.稳定性.安全性等等),而另外一个重要作用是给人阅读.对于机器来说只要代码正确就能够正确的运行程序,但是人不同,如果代码编写混乱就会对代码阅读造成障碍,导致代码无法维护,甚至会导致代码重构等高成本活动,所以规范代码势在必行. 本文从以下几个方面介绍代码规范以及相关工具. .Net代码规范简介 代码格式规范 命名规范 布局规范 注释规范 代码使用规范 常用的代码规范工具 小结 .Net代码规范简介 文章开始提到过代码是

研发代码规范

研发代码规范 java代码基础规范主要参照 阿里巴巴Java开发手册(详尽版).pdf 推荐阅读书籍 重构-改善既有代码的设计.pdf 简化版规范如下: 开发理念 用心写代码,提炼真正的非功能性需求. 代码整洁干净到极致, 请参见<重构>和<代码整洁之道>. 极简代码, 高度复用,无重复代码和配置. 代码应在同一抽象层级. 修改功能时多考虑影响面, 不可留下没修改完全的部分. 只有一个需求时,不需扩展性.两个类似需求时, 再提炼扩展性. 开发行为规范 提交之前先确定模块的测试套件,

Apsara Clouder基础技能认证:阿里巴巴编码规范 考试备考题库

考试网址: https://edu.aliyun.com/clouder/exam/intro/33 共50道题 限时90分钟 阿里云大学Apsara Clouder基础技能认证——阿里巴巴编码规范认证考试.成绩在80分以上可获得认证证书.本考试应用了防作弊系统,请遵守考试秩序.(Java代码在线检测及IDE插件下载:https://edu.aliyun.com/course/417) [注意:本认证考试不提供错题答案查看] 答题开始即开始计时,中途不可暂停,如超时则自动提交 1.考试共 (50

Alibaba Java Coding Guidelines,以后我的Java代码规范,就靠它了

前言 对于Java代码规范,业界有统一的标准,不少公司对此都有一定的要求.但是即便如此,庞大的Java使用者由于经验很水平的限制,未必有规范编码的意识,而且即便经验丰富的老Java程序员也无法做到时刻将规范牢记于心.所以对于代码规范扫描工具,一经问世就广受青睐,阿里巴巴出品的Alibaba Java Coding Guidelines(阿里巴巴Java代码规约扫描,以下简称为AJCG)插件便是其中之一.与很多其它流行的同类工具(如FindBugs,Lint等)相比,它更专注于Java代码规范,而

作业三: 代码规范、代码复审、PSP

(1) 是否需要有代码规范         1.这些规范都是官僚制度下产生的浪费大家的编程时间.影响人们开发效率, 浪费时间的东西.(反对) 答:首先编码规范 包括了编码风格和其它规范 一个团队遵守一些规范有很多的好处! (1). 遵守编码风格使代码更容易维护 (2). 编码风格使形成代码集体所有制(集体所有制的作用很大,它能有效的增大巴士因子——一个项目能承受多少个程序员被车撞了而不影响项目的正常进行) (3). 编码风格能消除那些长久的纷争(你不需要喜欢这种编码风格.如果你不喜欢里面的某条规