资讯专栏INFORMATION COLUMN

JAVA代码规范

GHOST_349178 / 3225人阅读

摘要:前言作为一名全干打字员,干活时经常会被要求使用各种各样的语言去实现各种各样的需求,来回切换起来写的代码就会或多或少有点不规范。今天我们以为例,讲讲在代码中,我们需要注意的某些规范。

前言

作为一名全干打字员,干活时经常会被要求使用各种各样的语言去实现各种各样的需求,来回切换起来写的代码就会或多或少有点不规范。今天我们以JAVA为例,讲讲在代码中,我们需要注意的某些规范。(本文标准依赖于阿里巴巴的JAVA开发代码规范)

示例

以下举出本猿在工作中常常出现的问题,包括但不仅限于:

逻辑判断语句

if/else/for/while/do 语句中必须使用大括号,即使只有一行代码,避免使用下面的形式:

if(condition) statements;

属性copy

很多童鞋喜欢使用 Apache Beanutils 进行属性的copy, Apache BeanUtils 性能较差,我们应该尽量避免使用,可以使用其他方案比如 Spring BeanUtils , Cglib BeanCopier

TestObject a = new TestObject();
TestObject b = new TestObject();
a.setX(b.getX());
a.setY(b.getY());  

覆写方法

所有的覆写方法,都必须要加上 @Override 注解。

类方法命名

方法名、参数名、成员变量、局部变量都应该统一使用 lowerCamelCase ,类名使用 UpperCamelCase 风格,遵从驼峰命名的标准,尽量避免如 _ -等字符连接,但以下情形例外:(领域模型的相关命名)DO / BO / DTO / VO / DAO。另外,类都应该加上创建者的信息,方法名也应该加上对应的参数及用途说明。

常量命名应该全部大写,但此间使用下划线隔开,力求语义表达完整清楚,不要嫌名字长。

Random实例

首先 Random 示例包括 java.util.Random 或者 Math.random(),我们应该避免其被多线程使用,虽然共享该实例是线程安全的,但会因竞争统一 seed 导致性能下降。

ThreadFactory namedThreadFactory = new ThreadFactoryBuilder().setNameFormat("demo-pool-%d").build();
ExecutorService singleThreadPool = new ThreadPoolExecutor(1, 1, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue(1024), namedThreadFactory, new ThreadPoolExecutor.AbortPolicy());
    singleThreadPool.execute(()-> System.out.println(Thread.currentThread().getName()));
    singleThreadPool.shutdown();   

+字符串拼接

在循环体内,我们应当使用 StringBuilderappend 方法进行字符串的连接。

反例:
    String result;
    for (String string : tagNameList) {
        result = result + string;
    }   
正例:
    StringBuilder stringBuilder = new StringBuilder();
    for (String string : tagNameList) {
        stringBuilder.append(string);
    }
    String result = stringBuilder.toString();   

equals判断

很多人喜欢使用下面的代码进行 equals 判断是否为某个值:

public static final String type = "FOOD";
if(Object.equals(type)){
    //do something
}

对象中的equals很容易抛空指针异常,所以我们应该尽量使用常量或者确定有值的对象来调用equals。

public void f(String str){
        String inner = "hi";
        if(inner.equals(str)){
            System.out.println("hello world");
        }
    }

集合初始化

我们往往在集合初始化的时候忘记指定集合的初始值大小,在高并发的情况下,这样很可能会造成内存的使用不当引起一系列的问题。所以在使用诸如 HashMap 的时候尽量指定初始值的大小。

反例:   
   Map map = new HashMap();   
正例: 
   Map map = new HashMap(16);   

注释

方法内部应当使用单行注释,在被注释语句的上方另起一行,使用 // 进行注释,多行注释则使用 /* */ ,强迫症下应注意与代码对齐。

public void method() {
        // Put single line comment above code. (Note: align "//" comment with code)
        int a = 3;
    
        /**
        * Some description about follow code. (Note: align "/**" comment with code)
        */
        int b = 4;
    } 

Switch语句

在每一个switch块内,每一个case都必须通过 break/return 来终止或者是注释说明程序继续执行到某一个case为止,并且都应该包含一个 default 语句放在最后,即便没有代码。

switch( x ){
        case 1 :
        break ;
        case 2 :
        break ;
        default :
    }  
结语

虽然我们往往写出的代码可能不是很高效、简洁,但是我们一定注意代码的可读性,毕竟代码除了机器看之外,也是给人看的。

福利

送福利送福利啦,本猿最近获得了三张 5QB 的抵用卷,本着蚊子再小也是肉的原则,把它送给在公众号上留言的前三位童鞋,留言的前三位童鞋看到后记得在后台留下QQ号联系打字员大大领取福利哟~

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/70807.html

相关文章

  • Java虚拟机规范(介绍)

    摘要:此处指定的虚拟机与平台兼容,并支持语言规范中指定的编程语言。第章说明了虚拟机的指令集,按字母顺序显示操作码助记符。 介绍 一点历史 Java®编程语言是一种通用的、并发的、面向对象的语言,它的语法类似于C和C++,但它省略了许多使C和C++复杂、混乱和不安全的特性。最初开发Java平台是为了解决为联网的消费者设备构建软件的问题,它旨在支持多种主机架构,并允许安全交付软件组件,为了满足这...

    chnmagnus 评论0 收藏0
  • 番外篇2-基本规范、注释、static关键字、import关键字

    摘要:今日份重点命名规范注释关键字关键字总结命名规范规范的包名名字管理是所有编程语言都必须重视的一个问题。比如说百度,其域名为,那么其对应的应用的包名前缀就应该为。是谁这么大牌总结本文主要介绍了中的命名规范注解关键字关键字等内容。 欢迎关注我的微信公众号,共同打牢Java的基础,向着远方进击 showImg(https://segmentfault.com/img/bVboaBO?w=129...

    codecraft 评论0 收藏0
  • Java编程规范(一)

    摘要:最近在看一本有关编程规范的书,书中精炼阐述了使用语言时应该遵循的一些原则。所以拥有良好一致的编程规范对于一个团队至关重要。二坚持最小惊奇原则在编码过程中尽量避免可能让软件用户感到意外的做法。 最近在看一本有关Java编程规范的书,书中精炼阐述了使用java语言时应该遵循的一些原则。接下来的一段时间我将在这里总结我的学习内容,也希望这一系列文章能够对有需要的人有所帮助。 不考虑任何编码规...

    Godtoy 评论0 收藏0
  • 乐字节Java变量与数据结构之一:Java编程规范、关键字和标识符

    摘要:大家好,我是乐字节的小乐,这次要给大家带来的是变量与数据类型。本文是第一集编程规范,关键字与标识符。后面我们要写一个程序的过程。需求分析实现代码体现注释的作用解释说明程序,提高了代码的阅读性。可以帮助我们调试程序。 大家好,我是乐字节的小乐,这次要给大家带来的是Java变量与数据类型。本文是第一集:Java编程规范,关键字与标识符。showImg(https://segmentfaul...

    qianfeng 评论0 收藏0
  • Java编程规范(二)

    摘要:二格式规范在上一篇的编程规范一中我们讲述了在编码中的一般原则,虽然这些原则并不涉及具体的代码规范,但是这些原则却是我们在开发过程中所应该遵循的规范与思想。不要把多个语句放在同一行里以免超过最大可接受宽度。 二、格式规范 在上一篇的java编程规范(一)中我们讲述了在Java编码中的一般原则,虽然这些原则并不涉及具体的代码规范,但是这些原则却是我们在Java开发过程中所应该遵循的规范与思...

    骞讳护 评论0 收藏0
  • Java编程风格学习(三)

    摘要:在上一篇的编程风格学习二中我们学习了一些在编码过程中的格式规范,遵循这些规范毋庸置疑是我们的书写高质量代码的前提与基础。二语言编程规范常量命名常量的每个单词均大写,单词之间使用下划线连接。方法表示动作,采用动词命名。 在上一篇的java编程风格学习(二)中我们学习了一些在Java编码过程中的格式规范,遵循这些规范毋庸置疑是我们的书写高质量代码的前提与基础。今天我们更进一步,一起来学习J...

    CoderDock 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<