十六条代码开发规范，让你总是领先一步

59 阅读 0 评论 39 点赞

我是靠谱客的博主个性飞鸟，最近开发中收集的这篇文章主要介绍十六条代码开发规范，让你总是领先一步，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

一：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>

建议统一使用Mybatis提供的动态指令where/set/if/foreach/choose等

二：迭代entrySet()获得Map的key和value

当循环中只需要获取Map的主键key时，使用keySet()是正确的，但是如果需要key和value时，迭代entrySet()才是更高效的做法
反例;

HashMap<String, String> map = new HashMap<>();
for (String key : map.keySet()){
    String value = map.get(key);
}

正例：

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

三：使用Collection.isEmpty()检测空

通常我们检测一个集合是否为空会通过检测集合的size来判断，即使用Collection.size();但是使用Collection.isEmpty()会使代码更加易读，且性能更优，因为Collection.isEmpty()的时间复杂度时O(1),而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.");

}

四：初始化集合时尽量指定大小

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

int[] arr = new int[]{1,2,3,4};
List<Integer> list = new ArrayList<>();
for (int i : arr){
 list.add(i);
}

正例：

int[] arr = new int[]{1,2,3,4};
//指定集合list 的容量大小
List<Integer> list = new ArrayList<>(arr.length);
for (int i : arr){
    list.add(i);
}

五：使用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);
}

也可以使用StringBufffer

六：若需要频繁的使用Collection.contains方法则使用Set

在java集合类库中，List的contains方法普遍时间复杂度为O(n),若代码中需要频繁使用，可以先将list转换成hashSet实现，将O(n)的时间复杂度降为O(1)
反例：

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);
}

正例：

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);
    }
}

七：使用静态代码块实现赋值静态成员变量

对于集合类型的静态成员变量，使用静态代码块赋值
反例：

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");
}

八:去除多余的方法

代码中应删除未使用的局部变量，方法参数，私有方法，字段，多余的括号等

九：工具类中屏蔽构造函数

工具类是一堆静态字段和函数的集合，其不应该被实例化，但是，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();
}

十：删除多余的异常捕获并抛出

使用try…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";
        }*/
    }
}

十一：字符串转化使用String.valueOf(value)代替""+value

反例：

int num = 520;
// "" + value
String strLove = "" + num;

正例：

int num = 520;
// String.valueOf() 效率更高
String strLove = String.valueOf(num);

十二：避免使用BigDecimal(double)

存在精度损失风险，在精确计算或值比较场景中可能导致系统异常
反例：

BigDecimal bigDecimal = new BigDecimal(0.11D);

正例：

BigDecimal bigDecimal1 = bigDecimal.valueOf(0.11D);

十三：返回空数组或集合而非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();
}

十四：优先使用常量或确定值调用equals方法

反例:

private static boolean fileReader(String fileName)throws IOException{

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

正例：

private static boolean fileReader(String fileName)throws IOException{

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

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

十五：枚举的属性字段必须是私有且不可变

枚举通常被当做常量使用，如果枚举中存在公共属性字段或设置字段方法，那么这些枚举常量的属性很容易被修改；理想情况下，枚举中的属性字段是私有的，并在私有构造函数中赋值，没有对应的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;
    }
}

十六：tring.split()部分关键字需要转译

正例：

// . 需要转译 
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"]

最后

以上就是个性飞鸟为你收集整理的十六条代码开发规范，让你总是领先一步的全部内容，希望文章能够帮你解决十六条代码开发规范，让你总是领先一步所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。

本图文内容来源于网友提供，作为学习参考使用，或来自网络收集整理，版权属于原作者所有。

本文分类：代码质量管理
浏览次数：59 次浏览
发布日期：2023-09-13 08:15:09
本文链接：https://www.kaopuke.com/article/k-p-k_14_uzo_6_f2_14_zk5.html

十六条代码开发规范，让你总是领先一步

概述

一：Mybatis不要为了使用多条件查询而使用1=1

二：迭代entrySet()获得Map的key和value

三：使用Collection.isEmpty()检测空

四：初始化集合时尽量指定大小

五：使用StringBuilder拼接字符串

六：若需要频繁的使用Collection.contains方法则使用Set

七：使用静态代码块实现赋值静态成员变量

八:去除多余的方法

九：工具类中屏蔽构造函数

十：删除多余的异常捕获并抛出

十一：字符串转化使用String.valueOf(value)代替""+value

十二：避免使用BigDecimal(double)

十三：返回空数组或集合而非NULL

十四：优先使用常量或确定值调用equals方法

十五：枚举的属性字段必须是私有且不可变

十六：tring.split()部分关键字需要转译

最后

评论列表共有 0 条评论

发表评论取消回复

十六条代码开发规范，让你总是领先一步

概述

一：Mybatis不要为了使用多条件查询而使用1=1

二：迭代entrySet()获得Map的key和value

三：使用Collection.isEmpty()检测空

四：初始化集合时尽量指定大小

五：使用StringBuilder拼接字符串

六：若需要频繁的使用Collection.contains方法则使用Set

七：使用静态代码块实现赋值静态成员变量

八:去除多余的方法

九：工具类中屏蔽构造函数

十：删除多余的异常捕获并抛出

十一：字符串转化使用String.valueOf(value)代替""+value

十二：避免使用BigDecimal(double)

十三：返回空数组或集合而非NULL

十四：优先使用常量或确定值调用equals方法

十五：枚举的属性字段必须是私有且不可变

十六：tring.split()部分关键字需要转译

最后

相关文章

评论列表共有 0 条评论

发表评论 取消回复

发表评论取消回复