java代码规范_插件 java代码编写规范

java编码规范有哪些？

尽量使用完整的英文描述符，采用适用于相关领域的术语，采用大小写混合使名字可读。

JAVA代码规范：

(1)类名首字母应该大写。字段、方法以及对象（句柄）的首字母应小写。对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。例如：

ThisIsAClassName

thisIsMethodOrFieldName

若在定义中出现了常数初始化字符，则大写static final基本类型标识符中的所有字母。这样便可标志出它们属于编译期的常数。Java包（Package）属于一种特殊情况：它们全都是小写字母，即便中间的单词亦是如此。对于域名扩展名称，如com，org，net或者edu等，全部都应小写（这也是Java1.1和Java1.2的区别之一）。

(2)为了常规用途而创建一个类时，请采取"经典形式"，并包含对下述元素的定义：equals()

hashCode()

toString()

clone()（implement Cloneable）

implement Serializable

(3)对于自己创建的每一个类，都考虑置入一个main()，其中包含了用于测试那个类的代码。为使用一个项目中的类，我们没必要删除测试代码。若进行了任何形式的改动，可方便地返回测试。这些代码也可作为如何使用类的一个示例使用。

(4)应将方法设计成简要的、功能性单元，用它描述和实现一个不连续的类接口部分。理想情况下，方法应简明扼要。若长度很大，可考虑通过某种方式将其分割成较短的几个方法。这样做也便于类内代码的重复使用（有些时候，方法必须非常大，但它们仍应只做同样的一件事情）。

(5)设计一个类时，请设身处地为客户程序员考虑一下（类的使用方法应该是非常明确的）。然后，再设身处地为管理代码的人考虑一下（预计有可能进行哪些形式的修改，想想用什么方法可把它们变得更简单）。

(6)使类尽可能短小精悍，而且只解决一个特定的问题。下面是对类设计的一些建议：

一个复杂的开关语句：考虑采用"多形"机制

数量众多的方法涉及到类型差别极大的操作：考虑用几个类来分别实现

许多成员变量在特征上有很大的差别：考虑使用几个类

(7)让一切东西都尽可能地"私有"-private。可使库的某一部分"公共化"（一个方法、类或者一个字段等等），就永远不能把它拿出。若强行拿出，就可能破坏其他人现有的代码，使他们不得不重新编写和设计。若只公布自己必须公布的，就可放心大胆地改变其他任何东西。在多线程环境中，隐私是特别重要的一个因素-只有private字段才能在非同步使用的情况下受到保护。

(8)谨惕"巨大对象综合症。对一些习惯于顺序编程思维、且初涉OOP领域的新手，往往喜欢先写一个顺序执行的程序，再把它嵌入一个或两个巨大的对象里。根据编程原理，对象表达的应该是应用程序的概念。

相关问答

Q1: JAVA程序员怎么提高编码规范能力

之前在远标论坛讨论过着问题，可以集成一些插件到 Eclipse 中来规范代码：比如 checkStyle 可以规范你的编码标准，比如类中方法的数量，方法中行数的限制等等。 FindBugs 和 PMD 可以帮忙你进行非常必要的代码审查，可以找到一些 code 中潜在的缺陷以及性能问题。 PMD 还可以找到整个 Project 中是否存在比较扬中的 copy paste 问题。Metrics 可以检测出代码的复杂度 。

Q2: JAVA格式规范化软件,用JAVA写，求思路

我曾在iteye上总结过，希望可以帮到你。

内容如下：

一、命名

1、所有的类、属性、方法都遵守以字母和数字为主，尽量不要参与特殊符号如下划线。其次，除类名开头字母大写外，其他名字都要小写，然后第二个后的单词首字母大写，长度在30个字符以内。

2、局部变量和全局变量的名字不能相同。

3、变量命名时也不能与其它方法重名。

4、变量命名尽量清晰可读，并带有一定含义。

5、接口中的方法按照返回类型、方法名、参数、异常、分号的方式编写，由于接口中的方法默认都以public static

final修饰，所以返回类型前面可以不做声明。

二、代码排版

1、方法体内按照

静态变量(以static修饰)---注入或引入的关联变量(以@Autowired修饰或引入的service或DAO)---自己命名的变量

--- 无参构造 ---有参构造 ---方法内容 ---- getter和setter的方法

2、每个方法的长度控制在150行内。

3、方法中所有常量字符统一整理在某个类内,如Constants,其所有的属性都以public static

final修饰，并且变量名字全部大写，单词之间用下划线隔开。

4、代码编写完成后排除掉warning的黄色警告，再格式化代码，以增强代码的美观。其中Ctrl+Shift+f

格式化代码,Ctrl+Shift+o快速导包，同时去处没有用到import。

5、每个方法中的return不得超过3个。

6、不要为Boolean，Integer或String创建新的实例：

避免创建新的Boolean，Integer，String等实例。使用Boolean.valueOf(true)代替new

Boolean(true)。两种写法效果差不多但却可以改善性能。

7、在代码块周围使用大括号:

永远不要忘记在块类型语句（如：if,for,while）周围使用大括号。这可以减少代码歧义并且避免在你修改代码块的时候产生新的bug。

8、养成写注释的好习惯。

Q3: eclipse alibaba代码规范插件怎么使用

在开发中，好的编程风格可以提升团队合作能力，提升开发的效率，但是每个人都有自己的编程习惯，如何能够将大家的编程风格统一，这个在团队中也很重要;

在Java编程中，阿里出版过一套关于Java的开发规范手册，我们可以在开发中按照这一套手册来进行开发，但是手册的内容比较多，因此阿里也专门提供了一套编码规范的插件，可以将插件安装到我们的开发环境中提升开发效率。

IDEA中阿里编码规范的安装：

1. 进入File-Setting

2.选择Plugins选项

3.在Plugins页面选择Marketplace选项，然后输入ali，会将ali相关的插件列出来

选择Alibaba Java Coding Guidelins进行安装，安装完成之后，需要重新启动IDEA，插件才可以生效。

之后的开发中，如果我们的编码有不规范的地方，IDEA就会有相应的提示。

或者我们可以在页面中右击鼠标右键，在弹出的列表中选择编码规约扫描，就可以将扫描结果列出来。

扫描之后结果会在下方列出来，比如未增加创建者信息，不允许任何魔法值等，并会详细定位到代码位置，而且也会详细介绍原因并且给出正确的代码示例。

由于阿里是我们国内的企业，因此阿里规范插件给我们提示的时候，也会按照中文的方式给我们提示，对于英语不好的人来说，方便了很多。

使用阿里规范的时候，也可以和Git进行组合一起操作，就是当我们选择提交代码的时候，可以将检查规范的选项勾选，这样在提交的时候，如果有不规范的代码，IDEA就会提示我们是否确认要提交。

无法查找到插件解决办法：

有时候我们在搜索插件的时候，由于网络原因，经常性的搜索不到插件，这时候我们就需要离线进行安装插件;

首先我们需要先到IDEA官网查找我们需要的插件信息：

输入我们想要安装的插件信息进行搜索，查找到之后选择进入插件详情页面

在详情页中我们可以选择不同版本的插件进行下载，将插件下载好之后我们就可以在我们IDEA中离线进行安装插件了;

离线安装插件的过程是在插件页面选择installed旁边的按钮，选择Install Plugin From Disk;之后在自己电脑上选择刚才下载的插件，就可以离线进行安装了，安装好之后同样需要重新启动IDEA插件才可以生效。

除了阿里代码规范之外，我们也可以选择其他的代码规范插件，比如SonarLint，其实开发中不论是用哪种插件，都是为了让我们养成好的编程风格，因此，在编程中，我们要养成良好的编程风格，不搞特殊，这样才能提升开发的效率。

以上就是关于代码规范插件怎么使用的讲解，更多关于java编程方面的问题可以看下这个视频教程：网页链接，希望我的回答能帮到你。

Q4: eclipse中提交java代码，该怎么设置 才能使得 如果不符合java代码规范，被svn拒绝提交。

作为PM，这种问题应该是相当苦恼，上面有压力，下面不争气。

你的想法很好，我觉得这个想法国外的PM一定已经实现这样的功能。

在这块的话，以前我们公司是用制度来约束：

我们每个人每天尽量少提交（但至少一次），每次提交都用CheckStyle检查合格后才能提交，否则质量控制那边再进行检查时，如果CheckStyle不通过，就会被惩罚

Q5: idea阿里巴巴规范插件报错

等级调到Inspactions。idea是阿里巴巴所研发java代码规范_插件的代码规范插件java代码规范_插件，idea阿里巴巴规范插件报错等级调到Inspactions即可java代码规范_插件，规范基于《阿里巴巴Java开发手册》，在IntelliJ IDEA的插件管理中直接搜索Alibaba Java Coding Guidelines即可。

java代码规范_插件的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于java代码编写规范、java代码规范_插件的信息别忘了在本站进行查找喔。