提高开发效率,比较重视代码规范,尤其是可扩展性和可维护性,以及可读性。如果你是一个刚进公司的开发者,最好先问问前辈是否有

内部的开发规范,花点时间过一遍。即使提交代码没有review的步骤,自己心里应该有个规范。业内比较统一的此处不总结。

  一 、命名风格

  1、抽象类以Abstract或Base开头,异常类以Exception结尾,枚举类以Enum结尾,常量类以Consts结尾,测试类以Test结尾

  2、数组定义中类型与中括号紧挨 int[] arr;

  3、POJO类中布尔类型的变量,都不要加is前缀

  4、包名使用单数形式,类名若有复数含义可用复数形式,如Utils

  5、除非业内公认的缩写,单词不要缩写

  6、若使用了设计模式,以模式名结尾,如OrderFactory,ServiceProxy

  7、接口类的方法和属性不要加任何修饰符号,1.8以前的方法默认都是public abstract 修饰,属性都是public static final的

1.8及以后的加入了static和default修饰符,这两种修饰的方法都需要方法体

  8、接口和实现类:XxxService,XxxServiceImpl,XxxDao,XxxDaoImpl

  9、结构分层的类的方法命名:

    (1)获取单个对象用get做前缀 getObject

    (2)获取多个对象用list做前缀+复数形式结尾 listObjects

    (3)获取统计值用count做前缀

    (4)插入方法用save/insert做前缀

    (5)删除用remove/delete做前缀

    (6)修改用update做前缀

    (7)2种VO:数据表对象xxxDO,网页视图对象xxxVO

  二、常量定义

  1、long型赋值以大写的L结尾,以免数字1与小写字母l混淆

  2、常量类也要分类,不要全部放在一起。比如缓存相关的常量用CacheConsts,系统配置相关的用ConfigConsts,

这些类均放在constant包下,类内部的常量放在本类中使用,不要公开出来放在常量类中

  3、变量值仅在一个固定范围内变化的,用enum类型定义。比如常见的数据库字段值的汉字转义

  三、代码格式

  1、大括号,看示例:(另外左侧大括号与字符留一个空格)   

int a(){};

int a(){
System.out.println("1");
}
int a(int b){
if(b==1){
System.out.println("1");
}else if(b==2){
System.out.println("2");
}else{
System.out.println("3");
}
}

  2、小括号,左右小括号与字符都不留空格。if/for/while等保留字与括号加一个空格

  3、运算符左右都加一个空格

  4、使用统一的Tab缩进,自行在IDE等开发工具上提前设置

  5、换行:运算符以及点号调用符与下文一起换行,参数换行在逗号后换行。最常见的是append("xxx")方法

  6、IDE统一设置text file encoding为utf-8;换行符使用Unix格式,不要用Windows格式

  7、方法总行数不要过多,一般建议是80行,额外逻辑应提取出来独立一个方法,使主干逻辑清晰

  8、除了逻辑或者业务意义需要加一个空行来隔开,其他的情况不要出现无意义的空行

最后:Intellij类写完了一定要按Ctrl+Alt+O,Ctrl+Alt+L;  Eclipse类写完了一定要按Ctrl+Shift+F,否则你一定要良心过不去

java编程规约一的更多相关文章

  1. java编程规约二

    四.OOP规约(Object Oriented Programming,面向对象设计) 1.静态变量和静态方法直接用类名访问,不要再new 对象去访问 2.方法覆盖必须加@Override注解 3.尽 ...

  2. java编程规约三

    七.集合处理 1.尽量使用String对象做Map的key 2.list转数组,用list的toArray(T[] array),传入的参数array是类型完全一样的数组,大小是list.size() ...

  3. java基础- Java编程规范与注释

    一 前言 java编程规约是指在java代码编写过程中通俗的约定:通常我们是要遵守这些规范:这好比我们在生活中要遵守的道德准则,如果你做的事情超出了道德的底线,那就有可能会受到社会抨击:在java编程 ...

  4. 点评阿里JAVA手册之编程规约(OOP 规约 、集合处理 、并发处理 、其他)

    下载原版阿里JAVA开发手册  [阿里巴巴Java开发手册v1.2.0] 本文主要是对照阿里开发手册,注释自己在工作中运用情况. 本文难度系数为三星(★★★) 本文为第二篇 第一篇 点评阿里JAVA手 ...

  5. 点评阿里JAVA手册之编程规约(命名风格、常量定义、代码风格、控制语句、注释规约)

    下载原版阿里JAVA开发手册  [阿里巴巴Java开发手册v1.2.0] 本文主要是对照阿里开发手册,注释自己在工作中运用情况. 本文难度系数为一星(★) 码出高效.码出质量. 代码的字里行间流淌的是 ...

  6. 读阿里巴巴Java开发手册v1.2.0之编程规约有感【架构篇】

     不为过去蹉跎,改变当下. 为什么开篇就送这么一句话给大家,我相信很多处于1-3年码龄的哥们儿们,在平时的编码历程中编码的个性可能是多彩的,每个人都有每个人特定的风格,但是我们现在这么随意写,以后这么 ...

  7. 《阿里巴巴Java开发手册v1.2》解析(编程规约篇)

    之前在乐视天天研究各种底层高大上的东西,因为我就一个人,想怎么弄怎么弄.如今来了新美大,好好研读一下<阿里巴巴Java开发手册v1.2>.还要对这么看似简单的东西解析一番.毕竟现在带团队, ...

  8. 阿里Java开发手冊之编程规约

    对于程序猿来说,编程规范能够养成良好的编程习惯,提高代码质量,减少沟通成本.就在2月9号,阿里出了一份Java开发手冊(正式版),分为编程规约.异常日志.MySQL规约,project规约.安全规约五 ...

  9. Java 开发手册之编程规约

    一.编程规约 (一) 命名规约 1.[强制] 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束.(代码规范,易读) 反例: name / __name / $Object / n ...

随机推荐

  1. Python自学:第四章 切片

    # -*- coding: GBK -*- players = ['charles', 'martina', 'michael', 'florence', 'eli'] print(players[0 ...

  2. C#发邮件之命名空间System.Net.Mail

    1.添加一个类,取名为Email public class Email { /// <summary> /// 发送方发送方服务器地址 /// </summary> publi ...

  3. [JZOJ6355] 【NOIP2019模拟】普 24/100

    题目 题目大意 给你一个序列,对于所有\(k\in [1,n]\),求长度为\(k\)的子序列的最大权值,权值为\(a_1-a_2+a_3-...\pm a_k\) 思考历程 这题显然可以背包对吧-- ...

  4. BeautifulSoup 爬虫

    一 安装BeautifulSoup 安装Python的包管理器pip 然后运行 $pip3 install beautifulsoup 在终端里导入它测试下是否安装成功 >>>fro ...

  5. 利用Delphi全面控制Windows任务栏

    使用Windows95/NT/98操作系统的用户知道:Windows正常启动后,在电脑屏幕下方出现一块 任务栏.从系统功能角度而言,整个任务栏包括几个不同的子区域,从左至右依次是:开始 按钮.应用程序 ...

  6. 图片和base64 二进制相互转换

    package com.xldz.xlworkbench.util; import java.awt.image.BufferedImage; import java.io.ByteArrayInpu ...

  7. Python-爬虫-requests库用语post登录

    requests库很强大,支持HTTP连接保持和连接池,支持使用cookie保持会话,支持文件上传,支持自动确定响应内容的编码,支持国际化的URL和POST数据自动编码. 可以发送无参数的get请求, ...

  8. <读书笔记>001-以解决问题为导向的python编程实践

    以解决问题为导向的python编程实践 0.第0章:计算机科学 思考:计算机科学是否为计算机编程的简称? 编程的困难点:1.同时做2件事(编程语言的语法.语义+利用其解决问题)  2.什么是好程序(解 ...

  9. Palindrome Partition CodeForces - 932G 回文树+DP+(回文后缀的等差性质)

    题意: 给出一个长度为偶数的字符串S,要求把S分成k部分,其中k为任意偶数,设为a[1..k],且满足对于任意的i,有a[i]=a[k-i+1].问划分的方案数. n<=1000000 题解: ...

  10. Java笔记之public、protected、default和private

    参考链接:private public protected default区别 - Ma_xiao_shuai的博客 - CSDN博客