五年工作经验总结 16 条的代码规范
点击下方“逆锋起笔”,选择“设为星标”
如何更规范化编写Java 代码
Many of the happiest people are those who own the least. But are we really so happy with our IPhones, our big houses, our fancy cars?
忘川如斯,拥有一切的人才更怕失去。
背景:如何更规范化编写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>
正例:
<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。
二、 迭代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();
}
三、使用Collection.isEmpty() 检测空
使用Collection.size() 来检测是否为空在逻辑上没有问题,但是使用Collection.isEmpty() 使得代码更易读,并且可以获得更好的性能;除此之外,任何Collection.isEmpty() 实现的时间复杂度都是O(1) ,不需要多次循环遍历,但是某些通过Collection.size() 方法实现的时间复杂度可能是O(n)。O(1)纬度减少循环次数 例子
反例:
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),耗费时间和性能。
反例:
//初始化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);}
五、使用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 编译器无法进行优化,所以要手动使用StringBuildersb.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);}}
七、使用静态代码块实现赋值静态成员变量
对于集合类型的静态成员变量,应该使用静态代码块赋值,而不是使用集合实现来赋值。
反例:
//赋值静态成员变量反例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 为每个没有明确定义构造函数的类添加了一个隐式公有构造函数,为了避免不必要的实例化,应该显式定义私有构造函数来屏蔽这个隐式公有构造函数。
微信搜索readdot,关注后回复编程资源获取23种精品资料
反例:
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();}
十、删除多余的异常捕获并抛出
用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
把其它对象或类型转化为字符串时,使用String.valueOf(value) 比 ""+value 的效率更高。
反例:
//把其它对象或类型转化为字符串反例:
int num = 520;
// "" + value
String strLove = "" + num;
正例:
//把其它对象或类型转化为字符串正例:
int num = 520;
// String.valueOf() 效率更高
String strLove = String.valueOf(num);
十二、避免使用BigDecimal(double)
BigDecimal(double) 存在精度损失风险,在精确计算或值比较的场景中可能会导致业务逻辑异常。
反例:
// BigDecimal 反例
BigDecimal bigDecimal = new BigDecimal(0.11D);
正例:
// BigDecimal 正例
BigDecimal bigDecimal1 = bigDecimal.valueOf(0.11D);
图1. 失去精度
十三、返回空数组和集合而非 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();
}
十四、优先使用常量或确定值调用equals 方法
对象的equals 方法容易抛空指针异常,应使用常量或确定有值的对象来调用equals 方法。
微信搜索readdot,关注后回复编程资源获取23种精品资料
反例:
//调用 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);}
十五、枚举的属性字段必须是私有且不可变
枚举通常被当做常量使用,如果枚举中存在公共属性字段或设置字段方法,那么这些枚举常量的属性很容易被修改;理想情况下,枚举中的属性字段是私有的,并在私有构造函数中赋值,没有对应的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 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"]
图2. String.split(String regex) 正反例
逆锋起笔
是一个专注于程序员圈子的技术平台,你可以收获最新技术动态
、最新内测资格
、BAT等大厂的经验
、精品学习资料
、职业路线
、副业思维
,微信搜索逆锋起笔
关注!
你还有什么想要补充的吗?
6 个常用的 API 接口在线管理平台13 个优秀的 Vue 开源项目及合集推荐15 款程序员常用开发工具如何评价一个开源项目?是它了比尔·盖茨 2021~2016 年度喜爱书单,附下载方式
五年工作经验总结 16 条的代码规范相关推荐
- Web前端开发的思考与经验----五年工作经验
最近几年对于web前端的传闻很多,比如人才稀缺,简单易学,待遇丰厚,整体势头发展良好等等.遇到过一个不太熟搞后台开发的同事跑来问我学习前端需要掌握哪些内容,也听说过一个搞IOS开发准备自学前端半个月然 ...
- 十五年工作经验的程序员,下面分享一篇职场经验的文章
当我步入职场时,我并没有预料到工作中会遇到的各种挑战.但是,随着时间的推移,我学到了很多关于如何成为一名成功的程序员的经验和教训.以下是我想分享给新手程序员的一些职场经验: 持续学习:技术发展非常迅速 ...
- PL/SQL开发五年工作经验精典实例
1. minus(差集)与intersect(交集) minus指令是运用在两个SQL语句上.它先找出第一个SQL语句所产生的结果,然后看这些结果有没有在第二个SQL语句的结果中,如果有的话,那这一笔 ...
- 软件测试五年工作经验自我评价,测试工程师自我评价_测试工程师自我评价范例...
[www.huxinfoam.com--自我介绍] 无意中在网上看到<测试工程师自我评价范例>,觉得有用就收藏了,改掉错别字就发到了,为了大家阅读方便. [自我评价一] 本人90年从事大型 ...
- 面试感悟----一名3年工作经验的程序员应该具备的技能,对于一些入门或者还在面试阶段的人有着很大的启发...
前言 因为和同事有约定再加上LZ自己也喜欢做完一件事之后进行总结,因此有了这篇文章.这篇文章大部分内容都是面向整个程序员群体的,当然因为LZ本身是做Java开发的,因此有一部分内容也是专门面向咱们Ja ...
- Java程序员三年的工作经验,却不如一个新人的工资高???
文章目录 一.关于程序员的几个阶段 第一阶段:三年 第二阶段:五年 第三阶段:十年 二.关于项目经验 三.关于专业技能 1.基本语法 2.集合 3.设计模式 4.多线程 5.JDK源码 6.框架 7. ...
- 面试感悟-------一名3年工作经验的程序员应该具备的技能
转载: 面试感悟-------一名3年工作经验的程序员应该具备的技能 前言 因为和同事有约定再加上LZ自己也喜欢做完一件事之后进行总结,因此有了这篇文章.这篇文章大部分内容都是面向整个程序员群体的,当 ...
- 面试感悟—-一名3年工作经验的程序员应该具备的技能
文章来自:五月的仓颉 五月的仓颉 是一位非常优秀,乐于分享的大神,目前就职阿里 原文链接:https://www.cnblogs.com/xrq730/p/5260294.html 前言 因为和同事有 ...
- 3 年工作经验程序员应有的技能
前言 因为和同事有约定再加上LZ自己也喜欢做完一件事之后进行总结,因此有了这篇文章.这篇文章大部分内容都是面向整个程序员群体的,当然因为LZ本身是做Java开发的,因此有一部分内容也是专门面向咱们Ja ...
最新文章
- 【 C 】关于变量、地址、指针变量等关系的一点思考
- WEBSERVICE之JDK开发webservice
- java dbtype_Java实现数据库的读写分离
- 利用自定命令打开常用软件,小白秒变大神。
- oracle增加字段为主键自增_在 Oracle 中设置自增列
- 【OpenCV 例程200篇】01. 图像的读取(cv2.imread)
- 训练代码_无需一行代码,完成模型训练和部署,这个AI工具开始公测
- 解决树莓派的gpio口不能读取ds18b20的设备文件
- 交易系统开发(六)——HFT高频交易
- SPSS基础教程—怎样对数据进行综合评价排名
- Java中使用正则表达式
- 倒闭潮之后 快消B2B要如何做才能实现盈利
- 魔众视频管理系统 v3.2.0 系统自动升级,页面SEO优化
- apk安装时so库存放路径
- Ubuntu14.04上安装calamari
- iOS 权限设置判断和跳转 - 最全最详细
- TSFS终端存储文件系统边缘计算技术构架
- Linux Log文件常用命令
- Azure Kinect DK 基本开发流程
- 五十八、Sqoop的常用参数及命令
热门文章
- 收发EtherCAT帧——ecx_getindex函数
- Avro RPC 之 Protocol 定义和代码生成
- haproxy配置负载均衡
- [最新] Android 代码规范大全(Android开发速看),2021年最新大厂Android面试笔试题目
- 积分球式光源色温校准
- android获取imei需要read_phone_state吗,Firemonkey android read_phone_state运行时权限要求获取IMEI...
- 数据分析师有发展前景吗?
- 【AIOT】语音学习
- android烤机按键变慢,Android8.0平台Camera monkey拷机卡死异常
- Python入门习题大全——大号T恤