16条代码规范建议，快看看自己做到没

最新推荐文章于 2023-08-20 21:18:35 发布
最新推荐文章于 2023-08-20 21:18:35 发布
阅读量213 收藏
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xingduan5153/article/details/104856573
版权

推荐阅读：

1、MyBatis 不要为了多个查询条件而写 1 = 1

当遇到多个查询条件，使用where 1=1 可以很方便的解决我们的问题，但是这样很可能会造成非常大的性能损失，因为添加了 “where 1=1 ”的过滤条件之后，数据库系统就无法使用索引等查询优化策略，数据库系统将会被迫对每行数据进行扫描（即全表扫描） 以比较此行是否满足过滤条件，当表中的数据量较大时查询速度会非常慢；此外，还会存在SQL 注入的风险。

反例：

<select id="queryBookInfo" parameterType="com.tjt.platform.entity.BookInfo" resultType="java.lang.Integer">
 select count(*) from t_rule_BookInfo t where 1=1
<if test="title !=null and title !='' ">
 AND title = #{title} 
</if> 
<if test="author !=null and author !='' ">
 AND author = #{author}
</if> 
</select>

正例：

<select id="queryBookInfo" parameterType="com.tjt.platform.entity.BookInfo" resultType="java.lang.Integer">
 select count(*) from t_rule_BookInfo t
<where>
<if test="title !=null and title !='' ">
 title = #{title} 
</if>
<if test="author !=null and author !='' "> 
 AND author = #{author}
</if>
</where> 
</select>

UPDATE 操作也一样，可以用标记代替 1=1。

2、迭代entrySet() 获取Map 的key 和value

当循环中只需要获取Map 的主键key时，迭代keySet() 是正确的；但是，当需要主键key 和取值value 时，迭代entrySet() 才是更高效的做法，其比先迭代keySet() 后再去通过get 取值性能更佳。

反例：

//Map 获取value 反例:
HashMap<String, String> map = new HashMap<>();
for (String key : map.keySet()){
    String value = map.get(key);
}

正例：

//Map 获取key & value 正例:
HashMap<String, String> map = new HashMap<>();
for (Map.Entry<String,String> entry : map.entrySet()){
 String key = entry.getKey();
 String value = entry.getValue();
}

3、使用Collection.isEmpty() 检测空

使用Collection.size() 来检测是否为空在逻辑上没有问题，但是使用Collection.isEmpty() 使得代码更易读，并且可以获得更好的性能；除此之外，任何Collection.isEmpty() 实现的时间复杂度都是O(1) ，不需要多次循环遍历，但是某些通过Collection.size() 方法实现的时间复杂度可能是O(n)

反例：

LinkedList<Object> collection = new LinkedList<>();
if (collection.size() == 0){
 System.out.println("collection is empty.");
}

正例：

LinkedList<Object> collection = new LinkedList<>();
if (collection.isEmpty()){
    System.out.println("collection is empty.");
}

//检测是否为null 可以使用CollectionUtils.isEmpty()
if (CollectionUtils.isEmpty(collection)){
    System.out.println("collection is null.");

}

4、初始化集合时尽量指定其大小

尽量在初始化时指定集合的大小，能有效减少集合的扩容次数，因为集合每次扩容的时间复杂度很可能时O(n)，耗费时间和性能。

反例：

//初始化list，往list 中添加元素反例：
int[] arr = new int[]{1,2,3,4};
List<Integer> list = new ArrayList<>();
for (int i : arr){
 list.add(i);
}

正例：

//初始化list，往list 中添加元素正例：
int[] arr = new int[]{1,2,3,4};
//指定集合list 的容量大小
List<Integer> list = new ArrayList<>(arr.length);
for (int i : arr){
    list.add(i);
}

5、使用StringBuilder 拼接字符串

一般的字符串拼接在编译期Java 会对其进行优化，但是在循环中字符串的拼接Java 编译期无法执行优化，所以需要使用StringBuilder 进行替换。

反例：

//在循环中拼接字符串反例
String str = "";
for (int i = 0; i < 10; i++){
    //在循环中字符串拼接Java 不会对其进行优化
    str += i;
}

正例：

//在循环中拼接字符串正例
String str1 = "Love";
String str2 = "Courage";
String strConcat = str1 + str2;  //Java 编译器会对该普通模式的字符串拼接进行优化
StringBuilder sb = new StringBuilder();
for (int i = 0; i < 10; i++){
   //在循环中，Java 编译器无法进行优化，所以要手动使用StringBuilder
    sb.append(i);
}

6、若需频繁调用Collection.contains 方法则使用Set

在Java 集合类库中，List的contains 方法普遍时间复杂度为O(n)，若代码中需要频繁调用contains 方法查找数据则先将集合list 转换成HashSet 实现，将O(n) 的时间复杂度将为O(1)。

反例：

//频繁调用Collection.contains() 反例
List<Object> list = new ArrayList<>();
for (int i = 0; i <= Integer.MAX_VALUE; i++){
    //时间复杂度为O(n)
    if (list.contains(i))
    System.out.println("list contains "+ i);
}

正例:

//频繁调用Collection.contains() 正例
List<Object> list = new ArrayList<>();
Set<Object> set = new HashSet<>();
for (int i = 0; i <= Integer.MAX_VALUE; i++){
    //时间复杂度为O(1)
    if (set.contains(i)){
        System.out.println("list contains "+ i);
    }
}

7、使用静态代码块实现赋值静态成员变量

对于集合类型的静态成员变量，应该使用静态代码块赋值，而不是使用集合实现来赋值。

反例：

//赋值静态成员变量反例
private static Map<String, Integer> map = new HashMap<String, Integer>(){
    {
        map.put("Leo",1);
        map.put("Family-loving",2);
        map.put("Cold on the out side passionate on the inside",3);
    }
};
private static List<String> list = new ArrayList<>(){
    {
        list.add("Sagittarius");
        list.add("Charming");
        list.add("Perfectionist");
    }
};

正例：

//赋值静态成员变量正例
private static Map<String, Integer> map = new HashMap<String, Integer>();
static {
    map.put("Leo",1);
    map.put("Family-loving",2);
    map.put("Cold on the out side passionate on the inside",3);
}

private static List<String> list = new ArrayList<>();
static {
    list.add("Sagittarius");
    list.add("Charming");
    list.add("Perfectionist");
}

8、删除未使用的局部变量、方法参数、私有方法、字段和多余的括号。

9、工具类中屏蔽构造函数

工具类是一堆静态字段和函数的集合，其不应该被实例化；但是，Java 为每个没有明确定义构造函数的类添加了一个隐式公有构造函数，为了避免不必要的实例化，应该显式定义私有构造函数来屏蔽这个隐式公有构造函数。

反例：

public class PasswordUtils {
//工具类构造函数反例
private static final Logger LOG = LoggerFactory.getLogger(PasswordUtils.class);

public static final String DEFAULT_CRYPT_ALGO = "PBEWithMD5AndDES";

public static String encryptPassword(String aPassword) throws IOException {
    return new PasswordUtils(aPassword).encrypt();
}

正例：

public class PasswordUtils {
//工具类构造函数正例
private static final Logger LOG = LoggerFactory.getLogger(PasswordUtils.class);

//定义私有构造函数来屏蔽这个隐式公有构造函数
private PasswordUtils(){}

public static final String DEFAULT_CRYPT_ALGO = "PBEWithMD5AndDES";

public static String encryptPassword(String aPassword) throws IOException {
    return new PasswordUtils(aPassword).encrypt();
}

10、删除多余的异常捕获并跑出

用catch 语句捕获异常后，若什么也不进行处理，就只是让异常重新抛出，这跟不捕获异常的效果一样，可以删除这块代码或添加别的处理。

反例：

//多余异常反例
private static String fileReader(String fileName)throws IOException{

    try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {
        String line;
        StringBuilder builder = new StringBuilder();
        while ((line = reader.readLine()) != null) {
            builder.append(line);
        }
        return builder.toString();
    } catch (Exception e) {
        //仅仅是重复抛异常 未作任何处理
        throw e;
    }
}

正例：

//多余异常正例
private static String fileReader(String fileName)throws IOException{

    try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {
        String line;
        StringBuilder builder = new StringBuilder();
        while ((line = reader.readLine()) != null) {
            builder.append(line);
        }
        return builder.toString();
        //删除多余的抛异常，或增加其他处理：
        /*catch (Exception e) {
            return "fileReader exception";
        }*/
    }
}

11、字符串转化使用String.valueOf(value) 代替 " " + value

把其它对象或类型转化为字符串时，使用String.valueOf(value) 比 ""+value 的效率更高。

反例：

//把其它对象或类型转化为字符串反例：
int num = 520;
// "" + value
String strLove = "" + num;

正例：

//把其它对象或类型转化为字符串正例：
int num = 520;
// String.valueOf() 效率更高
String strLove = String.valueOf(num);

12、避免使用BigDecimal(double)

BigDecimal(double) 存在精度损失风险，在精确计算或值比较的场景中可能会导致业务逻辑异常。

反例：

// BigDecimal 反例    
BigDecimal bigDecimal = new BigDecimal(0.11D);

正例：

// BigDecimal 正例
BigDecimal bigDecimal1 = bigDecimal.valueOf(0.11D);

13、返回空数组和集合而非 null

若程序运行返回null，需要调用方强制检测null，否则就会抛出空指针异常；返回空数组或空集合，有效地避免了调用方因为未检测null 而抛出空指针异常的情况，还可以删除调用方检测null 的语句使代码更简洁。

反例：

//返回null 反例
public static Result[] getResults() {
    return null;
}

public static List<Result> getResultList() {
    return null;
}

public static Map<String, Result> getResultMap() {
    return null;
}

正例：

//返回空数组和空集正例
public static Result[] getResults() {
    return new Result[0];
}

public static List<Result> getResultList() {
    return Collections.emptyList();
}

public static Map<String, Result> getResultMap() {
    return Collections.emptyMap();
}

14、优先使用常量或确定值调用equals 方法

对象的equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals 方法。

反例：

//调用 equals 方法反例
private static boolean fileReader(String fileName)throws IOException{

 // 可能抛空指针异常
 return fileName.equals("Charming");
}

正例：

//调用 equals 方法正例
private static boolean fileReader(String fileName)throws IOException{

    // 使用常量或确定有值的对象来调用 equals 方法
    return "Charming".equals(fileName);

    //或使用：java.util.Objects.equals() 方法
   return Objects.equals("Charming",fileName);
}

15、枚举的属性字段必须是私有且不可变

枚举通常被当做常量使用，如果枚举中存在公共属性字段或设置字段方法，那么这些枚举常量的属性很容易被修改；理想情况下，枚举中的属性字段是私有的，并在私有构造函数中赋值，没有对应的Setter 方法，最好加上final 修饰符。

反例：

public enum SwitchStatus {
    // 枚举的属性字段反例
    DISABLED(0, "禁用"),
    ENABLED(1, "启用");

    public int value;
    private String description;

    private SwitchStatus(int value, String description) {
        this.value = value;
        this.description = description;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

正例：

public enum SwitchStatus {
    // 枚举的属性字段正例
    DISABLED(0, "禁用"),
    ENABLED(1, "启用");

    // final 修饰
    private final int value;
    private final String description;

    private SwitchStatus(int value, String description) {
        this.value = value;
        this.description = description;
    }

    // 没有Setter 方法
    public int getValue() {
        return value;
    }

    public String getDescription() {
        return description;
    }
}

16、tring.split(String regex)部分关键字需要转译

使用字符串String 的plit 方法时，传入的分隔字符串是正则表达式，则部分关键字（比如 .| 等）需要转义。

反例：

// String.split(String regex) 反例
String[] split = "a.ab.abc".split(".");
System.out.println(Arrays.toString(split));   // 结果为[]

String[] split1 = "a|ab|abc".split("|");
System.out.println(Arrays.toString(split1));  // 结果为["a", "|", "a", "b", "|", "a", "b", "c"]

正例：

// String.split(String regex) 正例
// . 需要转译
String[] split2 = "a.ab.abc".split("\\.");
System.out.println(Arrays.toString(split2));  // 结果为["a", "ab", "abc"]

// | 需要转译
String[] split3 = "a|ab|abc".split("\\|");
System.out.println(Arrays.toString(split3));  // 结果为["a", "ab", "abc"]
Jav进阶道路
关注
Java岗面试必问！16条代码规范建议，看完这一篇就够了！
m0_56051002的博客
03-15 724
前言 我想对所有程序员说：除了看视频、做项目来提高自身的技术之外，还有一种提升自己的专业技能就是：多！看！书！（本文内提到的书单笔者整理出了一份电子档作为分享，文末有免费获取方式） 网络框架、中间件、容器、并发编程、虚拟机等最近几年在互联网行业是越来越火热，Netty、Docker、并发编程、虚拟机也是程序员不得不掌握的技术点，掌握熟练这些技术点，必能让你在“互联网寒冬”的这场大战中立于不败之地！今天我们就来了解当下最流行的那些新兴技术。 华为Java一面· 1H 闲聊偏多，问的技术性问题比较基础
代码规范20条
qq_39829437的博客
07-10 530
大到项目名、模块名、包名、对外暴露的接口，小到类名、函数名、变量名、参数名。 上一节课中我们讲了命名和注释，这一节课我们来讲一下代码风格（Code Style）。说起 代码风格，我们其实很难说哪种风格更好。最重要的，也是最需要我们做到的，是在团队、 项目中保持风格统一，让代码像同一个人写出来的，整齐划一。这样能减少阅读干扰，提高 代码的可读性。这才是我们在实际工作中想要实现的目标。 关于代码风格，我总结了 6 点我认为最值得关注的，今天跟你一块讨论学习一下。 1. 类、函数多大才合适？ 总体上来讲，类或
代码规范的那些事儿
ljchlx的专栏
07-06 735
作为一个苦逼的程序员，因为种种原因经常需要阅读别人写的代码。您是否有过因代码杂乱冗余而心生厌恶，您是否有过因代码晦涩难懂而抓狂，您是否有过因代码低级的逻辑错误而愤概，您是否有过因代码结构不合常规而需要到处查找，您是否有过因看到几百甚至上千行代码的方法而望洋兴叹，您是否有过因代码缺少注释而猜测以及花很多时间去理清楚前后逻辑。 　　苦逼的我全部遇到过并且很多很多，这些代码的作者从世界500强顶级
代码规范建议
smile_foreach的博客
09-29 189
类上方法上都要加注释,方法上不要用单行注释或多行注释,不要用行尾注释,类上的方法注释要标明日期和作者,连续两行以上代码注释尽量不要用 单行注释,命名要见名之意,单词之间尽量保证四个空格 ...
代码结构及一些代码规范建议
chyk1414的博客
01-23 425
一些感悟 代码结构和规范关系到项目的可持续维护以及维护的周期，非常重要，但真正重视并落地的很少 经典的MVC模式一般都能说出来，但真正落地到项目代码结构的时候，却缺少思考 当写代码和找代码让人感觉别扭的时候，就该考虑如何去优化了 一切皆对象，在规划代码结构的时候也需要有面向对象的思维方式 ...
2021Java春招，16条代码规范建议，快看看自己做到没
m0_60226911的博客
08-04 164
for (Map.Entry<String,String> entry : map.entrySet()){ String key = entry.getKey(); String value = entry.getValue(); } ## 3、使用Collection.isEmpty() 检测空 > 使用Collection.size() 来检测是否为空在逻辑上没有问题，但是使用Collection.isEmpty() 使得代码更易读，并且可以获得更好的性能；除此之外，任何Coll
写代码的一些规范
qq_60504871的博客
07-21 562
个人编程规范
Python代码规范
最新发布
qq_45690050的博客
08-20 562
一万个人眼中有一万个哈姆雷特。”这句话用在代码规范上再合适不过了。在没有组织对规范进行限制要求的前提下，由于我们每个人的码风都不一样，所以导致我们的注释也不尽相同。本篇文章谈谈我平时写Python代码的规范，还请各位批评指正。......我认为方法之间空两行可以很好的区别于方法体内的空一行，同时也让自定义的方法更加明显。
iOS代码规范
iOS_greenHand的博客
05-13 487
命名规则 一般原则 清晰 命名最好清晰又简洁,但是不能过于简洁而失去了清晰。 不要用单词的简写，尽量用单词的全称。可以看看苹果的API格式，仿照苹果的命名，尽量用英文，而不是拼音。 insertObject:atIndex: //这是个好例子 insert:at: //不够清晰,插入的是什么?at又指的是什么? 名称通常不缩写,即使名称很长,也要拼写完全 代码 点评 d...
新手必看，给Linux初学者的建议
08-20
对于想要快速踏入嵌入式行业并从事产品研发的人来说，学习嵌入式Linux无疑是一条有效的路径。 **1. 学习前的准备工作** 要成为一名合格的嵌入式Linux工程师，首先要对软硬件知识有全面的理解，并建立起规范的开发...
今日头条源代码
01-07
直接创建2个工程，把他们导入即可； 百分百源代码，已调试通过
原理竟然是这！16条代码规范建议
CHAMPION8888的博客
07-09 208
01 蚂蚁金服面试题之MySQL 之前的阿里面试题都有做总结，具体面试题内容整理成了文档，本文是针对MySQL系列的，所以下面只展示了自己第一次面试阿里时被吊打问到的一些MySQL难题。 1、请解释关系型数据库概念及主要特点？ 2、请说出关系型数据库的典型产品、特点及应用场景？ 3、请详细描述 SQL 语句分类及对应代表性关键字。 4、什么是 MySQL 多实例，如何配置 MySQL 多实例？ 5、如何加强 MySQL 安全，请给出可行的具体措施？ 6、误操作执行了一个 drop 库 SQL 语句，如何完整
代码优化建议(持续更新...)
qq_41785135的博客
03-08 403
此文记录在工作学习中遇到的代码优化的方法和建议.不是全部,但是会持续更新. 1.尽可能使用局部变量 调用方法时传递的参数以及在调用中创建的临时变量都保存在栈中,速度较快,其他变量:如静态变量 实例变量等都在堆中创建,速度较慢.另外,栈中创建的变量,随着方法运行结束这些内容都没有了,不需要额外的垃圾回收. 2. 尽量减少对变量的重复计算 对方...
2021年Java开发进阶课程！和阿里大牛的技术面谈，进阶学习资料！
m0_56004877的博客
03-15 456
引入 Netty的源码分析中, 采用自底向上的方式进行分析, 底指的是一个个的组件, 上指的是整体的架构及一系列操作的执行流程举个简单的例子。 Netty服务端的启动流程中, 必然会调用bind方法, 一个bind方法的内部, 其实完成了许许多多的内容, 涉及了许多组件, 如果我们从入口开始讲起, 那么一遇到不认识的组件就容易陷入迷茫, 所以我们从基础组件开始讲起,。 最后再来讲Netty的启动流程, 这样, 在有了基础组件的知识的前提下, 再来看启动流程就会非常的清晰, 本篇文章讲的组件是Netty中的常
Java开发实战！超过500人面试阿里，Java岗
m0_56130999的博客
03-15 454
前言 今年的金三银四已经过去一大半了，在这其中参与过不少面试，2021都说工作不好找，这也是对开发人员的要求变向的提高了。 之前在Github上收获15K+star的Java核心神技（这参数，质量多高就不用我多说了吧）非常全面，包含基础知识、Java集合、JVM、多线程并发、spring原理、微服务、Netty 与RPC 、Kafka、日记、设计模式、Java算法、数据库、Zookeeper、分布式缓存、数据结构等等内容非常丰富，已经帮很多人拿下互联网一线公司的offer Spring Security观后
这样规范写代码，同事直呼“666”
Java团长的博客
10-22 532
来源：cnblogs.com/taojietaoge/p/11575376.html一、MyBatis 不要为了多个查询条件而写 1 = 1当遇到多个查询条件，使用whe...
如何高效的做代码检视（Code Review）
weixin_34406796的博客
02-28 721
2019独角兽企业重金招聘Python工程师标准>>> ...
怎么样来提高自己的代码质量
C语言C++学习俱乐部：765860056
09-28 427
说起代码质量，脑子里会冒出很多词，命名规范、格式规范、日志规范、单元测试覆盖率… 但我觉得，代码质量总结起来就两个：好看和好用。 好看是指代码可读性好，容易理解、容易维护，别人接手了不骂你；好用则指代码健壮，不容易出错，机器跑着不骂你。即使出错，也容易定位，容易止损和恢复。 为何需要提高代码质量？ 以下是我认为的几点： 提升代码的可维护性，降低新人接手的成本 促进知识共享，降低团队间应用流转的难度 建设写好代码、做好设计的团队氛围 如何才能拥有高质量的代码 有两种途径： 第一种途径：先有好的设计—>.
C/C++代码规范：对齐缩进与编程原则
"该资源是一份关于C语言和C++代码规范的面试题与解答，主要涉及代码的排版、注释、命名以及一些杂项规定。文档旨在提高代码的可读性和可维护性，强调一致性原则。" 在这份资料中，首先提到了编码规范的重要性，特别...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值