如何更规范化编写Java 代码

最新推荐文章于 2024-10-10 23:42:47 发布

天狼1222

最新推荐文章于 2024-10-10 23:42:47 发布

阅读量185

点赞数

分类专栏： java 文章标签： java 代码优化

原文链接：https://www.cnblogs.com/taojietaoge/p/11575376.html

版权

java 专栏收录该内容

80 篇文章 3 订阅

订阅专栏

作者：涛姐涛哥
出处：https://www.cnblogs.com/taojietaoge/p/11575376.html

原文： https://www.cnblogs.com/taojietaoge/p/11575376.html
本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接。

今天看到一篇文章，觉得很不错。把其中觉得几个点容易犯错的，再进行说明：

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

五、使用StringBuilder 拼接字符串

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

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

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

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

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

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

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

总结：

背景：如何更规范化编写Java 代码的重要性想必毋需多言，其中最重要的几点当属提高代码性能、使代码远离Bug、令代码更优雅。

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

PS：为什么会写where 1 = 1，考虑到后面是要跟and 相邻的。其实大可不必， <where >元素只会在子元素返回任何内容的情况下才插入 “WHERE” 子句。而且，若子句的开头为 “AND” 或 “OR”，where 元素也会将它们去除。所以大胆使用<where> 不要担心 and或者or

正例：

<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 操作也一样，可以用<set> 标记代替 1=1。

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

六、若需频繁调用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);
	 }
 }

PS: 这边适合把List<String>, List<Long>... 单个类型的，转换成set的类型，再进行判断。

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

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

反例：

//赋值静态成员变量 
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");
	}

PS: 这个点容易忘记，常容易直接赋值

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

把提示黄体的内容能解决的，尽量解决掉

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

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

PS: 定义私有构造函数来屏蔽这个隐式公有构造函数。这个几乎是被忽略的，以后可以多用起来。

十一、字符串转化使用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);

PS：这个没什么好说的，一般也不会用" " + value。就是在String.valueOf使用的时候，注意null的判断：

String strLove = num == null? "":String.valueOf(num);

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

PS：返回空对象也不要返回null

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

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

PS: 这个点也经常被忽略掉！下次用的时候，记得属性添加final修饰

十六、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"]

PS：看到这个例子，才想起来。平时都没遇到过，更多是分离逗号的。

用 StringUtils.split 就好了，就不用转义啥的，还容易忘记。

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

总结：

把常见却可能忽略的点，再重复了下，做一些简要的说明。在检查代码的时候，回顾把这些点，看看哪些是自己没做好的，不断强化。

作者：涛姐涛哥
出处：https://www.cnblogs.com/taojietaoge/p/11575376.html

原文： https://www.cnblogs.com/taojietaoge/p/11575376.html
本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接。