工作了几个月,感觉自己代码很不规范,有很多冗余,比较乱,请问怎么针对性的改善代码规范？

下面分享一篇大佬的规范代码实操。

代码能够写成这样 666 啊，大佬收徒吗？

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

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

反例：

1. <select id="queryBookInfo" parameterType="com.tjt.platform.entity.BookInfo" resultType="java.lang.Integer">

2. select count(*) from t_rule_BookInfo t where 1=1

3. <if test="title !=null and title !='' ">

4. AND title = #{title}

5. </if>

6. <if test="author !=null and author !='' ">

7. AND author = #{author}

8. </if>

9. </select>

正例：

1. <select id="queryBookInfo" parameterType="com.tjt.platform.entity.BookInfo" resultType="java.lang.Integer">

2. select count(*) from t_rule_BookInfo t

3. <where>

4. <if test="title !=null and title !='' ">

5. title = #{title}

6. </if>

7. <if test="author !=null and author !='' ">

8. AND author = #{author}

9. </if>

10. </where>

11. </select>

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

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

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

反例：

1. //Map 获取value 反例:

2. HashMap<String, String> map = new HashMap<>();

3. for (String key : map.keySet()){

4. String value = map.get(key);

5. }

正例：

1. //Map 获取key & value 正例:

2. HashMap<String, String> map = new HashMap<>();

3. for (Map.Entry<String,String> entry : map.entrySet()){

4. String key = entry.getKey();

5. String value = entry.getValue();

6. }

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

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

反例：

1. LinkedList<Object> collection = new LinkedList<>();

2. if (collection.size() == 0){

3. System.out.println("collection is empty.");

4. }

正例：

1. LinkedList<Object> collection = new LinkedList<>();

2. if (collection.isEmpty()){

3. System.out.println("collection is empty.");

4. }

5.  

6. //检测是否为null 可以使用CollectionUtils.isEmpty()

7. if (CollectionUtils.isEmpty(collection)){

8. System.out.println("collection is null.");

9.  

10. }

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

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

反例：

1. //初始化list，往list 中添加元素反例：

2. int[] arr = new int[]{1,2,3,4};

3. List<Integer> list = new ArrayList<>();

4. for (int i : arr){

5. list.add(i);

6. }

正例：

1. //初始化list，往list 中添加元素正例：

2. int[] arr = new int[]{1,2,3,4};

3. //指定集合list 的容量大小

4. List<Integer> list = new ArrayList<>(arr.length);

5. for (int i : arr){

6. list.add(i);

7. }

五、使用StringBuilder 拼接字符串

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

反例：

1. //在循环中拼接字符串反例

2. String str = "";

3. for (int i = 0; i < 10; i++){

4. //在循环中字符串拼接Java 不会对其进行优化

5. str += i;

6. }

正例：

1. //在循环中拼接字符串正例

2. String str1 = "Love";

3. String str2 = "Courage";

4. String strConcat = str1 + str2; //Java 编译器会对该普通模式的字符串拼接进行优化

5. StringBuilder sb = new StringBuilder();

6. for (int i = 0; i < 10; i++){

7. //在循环中，Java 编译器无法进行优化，所以要手动使用StringBuilder

8. sb.append(i);

9. }

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

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

反例：

1. //频繁调用Collection.contains() 反例

2. List<Object> list = new ArrayList<>();

3. for (int i = 0; i <= Integer.MAX_VALUE; i++){

4. //时间复杂度为O(n)

5. if (list.contains(i))

6. System.out.println("list contains "+ i);

7. }

正例:

1. //频繁调用Collection.contains() 正例

2. List<Object> list = new ArrayList<>();

3. Set<Object> set = new HashSet<>();

4. for (int i = 0; i <= Integer.MAX_VALUE; i++){

5. //时间复杂度为O(1)

6. if (set.contains(i)){

7. System.out.println("list contains "+ i);

8. }

9. }

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

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

反例：

1. //赋值静态成员变量反例

2. private static Map<String, Integer> map = new HashMap<String, Integer>(){

3. {

4. map.put("Leo",1);

5. map.put("Family-loving",2);

6. map.put("Cold on the out side passionate on the inside",3);

7. }

8. };

9. private static List<String> list = new ArrayList<>(){

10. {

11. list.add("Sagittarius");

12. list.add("Charming");

13. list.add("Perfectionist");

14. }

15. };

正例：

1. //赋值静态成员变量正例

2. private static Map<String, Integer> map = new HashMap<String, Integer>();

3. static {

4. map.put("Leo",1);

5. map.put("Family-loving",2);

6. map.put("Cold on the out side passionate on the inside",3);

7. }

8.  

9. private static List<String> list = new ArrayList<>();

10. static {

11. list.add("Sagittarius");

12. list.add("Charming");

13. list.add("Perfectionist");

14. }

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

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

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

反例：

1. public class PasswordUtils {

2. //工具类构造函数反例

3. private static final Logger LOG = LoggerFactory.getLogger(PasswordUtils.class);

4.  

5. public static final String DEFAULT_CRYPT_ALGO = "PBEWithMD5AndDES";

6.  

7. public static String encryptPassword(String aPassword) throws IOException {

8. return new PasswordUtils(aPassword).encrypt();

9. }

正例：

1. public class PasswordUtils {

2. //工具类构造函数正例

3. private static final Logger LOG = LoggerFactory.getLogger(PasswordUtils.class);

4.  

5. //定义私有构造函数来屏蔽这个隐式公有构造函数

6. private PasswordUtils(){}

7.  

8. public static final String DEFAULT_CRYPT_ALGO = "PBEWithMD5AndDES";

9.  

10. public static String encryptPassword(String aPassword) throws IOException {

11. return new PasswordUtils(aPassword).encrypt();

12. }

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

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

反例：

1. //多余异常反例

2. private static String fileReader(String fileName)throws IOException{

3.  

4. try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {

5. String line;

6. StringBuilder builder = new StringBuilder();

7. while ((line = reader.readLine()) != null) {

8. builder.append(line);

9. }

10. return builder.toString();

11. } catch (Exception e) {

12. //仅仅是重复抛异常 未作任何处理

13. throw e;

14. }

15. }

正例：

1. //多余异常正例

2. private static String fileReader(String fileName)throws IOException{

3.  

4. try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {

5. String line;

6. StringBuilder builder = new StringBuilder();

7. while ((line = reader.readLine()) != null) {

8. builder.append(line);

9. }

10. return builder.toString();

11. //删除多余的抛异常，或增加其他处理：

12. /*catch (Exception e) {

13. return "fileReader exception";

14. }*/

15. }

16. }

文章到这里就结束了

为了让大家能够更加规范的编写代码，小编这里为大家准备了一份阿里巴巴开发手册，需要的小伙伴们可以添加vx免费领取以下资料

喜欢小编的分享可以点赞关注哦，小编持续为你分享最新文章 和 福利领取哦