java编码规范有哪些(阿里巴巴java编码规范)
本文总结了一套与java函数相关的编码规则,旨在给广大java程序员一些编码建议,有助于大家编写出更优雅、更高质、更高效的代码。
上文链接:link
内部函数参数尽量使用基础类型
案例一:内部函数参数尽量使用基础类型
现象描述:
// 调用代码 double price = 5.1d; int number = 9; double total = calculate(price, number); // 计算金额函数 private double calculate(double price, integer number) { return price * number; }
建议方案:
// 调用代码 double price = 5.1d; int number = 9; double total = calculate(price, number); // 计算金额函数 private double calculate(double price, int number) { return price * number; }
案例二:内部函数返回值尽量使用基础类型
现象描述:
// 获取订单总额函数 public double getorderamount(list<product> productlist) { double amount = 0.0d; for (product product : productlist) { if (objects.isnull(product) || objects.isnull(product.getprice()) || objects.isnull(product.getnumber())) { continue; } amount += calculate(product.getprice(), product.getnumber()); } return amount; } // 计算金额函数 private double calculate(double price, double number) { return price * number; }
建议方案:
// 获取订单总额函数 public double getorderamount(list<product> productlist) { double amount = 0.0d; for (product product : productlist) { if (objects.isnull(product) || objects.isnull(product.getprice()) || objects.isnull(product.getnumber())) { continue; } amount += calculate(product.getprice(), product.getnumber()); } return amount; } // 计算金额函数 private double calculate(double price, double number) { return price * number; }
此处只是举例说明这种现象,更好的方式是采用流式(stream)编程。
主要收益
- 内部函数尽量使用基础类型,避免了隐式封装类型的打包和拆包;
- 内部函数参数使用基础类型,用语法上避免了内部函数的参数空指针判断;
- 内部函数返回值使用基础类型,用语法上避免了调用函数的返回值空指针判断。
尽量避免返回的数组和列表为null
案例一:尽量避免返回的数组为null,引起不必要的空指针判断
现象描述:
// 调用代码 uservo[] users = queryuser(); if (objects.nonnull(users)) { for (uservo user : users) { // 处理用户信息 } } // 查询用户函数 private uservo[] queryuser() { // 查询用户列表 list<userdo> userlist = userdao.queryall(); if (collectionutils.isempty(userlist)) { return null; } // 转化用户数组 uservo[] users = new uservo[userlist.size()]; for (int i = 0; i < userlist.size(); i++) { userdo user = userlist.get(i); users[i] = new uservo(); users[i].setid(user.getid()); users[i].setname(user.getname()); } // 返回用户数组 return users; }
建议方案:
// 调用代码 uservo[] users = queryuser(); for (uservo user : users) { // 处理用户信息 } // 查询用户函数 private uservo[] queryuser() { // 查询用户列表 list<userdo> userlist = userdao.queryall(); if (collectionutils.isempty(userlist)) { return new uservo[0]; } // 转化用户数组 uservo[] users = new uservo[userlist.size()]; for (int i = 0; i < userlist.size(); i++) { userdo user = userlist.get(i); users[i] = new uservo(); users[i].setid(user.getid()); users[i].setname(user.getname()); } // 返回用户数组 return users; }
案例二:尽量避免返回的列表为null,引起不必要的空指针判断
现象描述:
// 调用代码 list<uservo> userlist = queryuser(); if (objects.nonnull(userlist)) { for (uservo user : userlist) { // 处理用户信息 } } // 查询用户函数 private list<uservo> queryuser(){ // 查询用户列表 list<userdo> userlist = userdao.queryall(); if(collectionutils.isempty(userlist)) { return null; } // 转化用户列表 list<uservo> uservolist = new arraylist<>(userlist.size()); for(userdo user : userlist) { uservo uservo = new uservo(); uservo.setid(user.getid()); uservo.setname(user.getname()); uservolist.add(uservo); } // 返回用户列表 return uservolist; }
建议方案:
// 调用代码 list<uservo> userlist = queryuser(); for (uservo user : userlist) { // 处理用户信息 } // 查询用户函数 private list<uservo> queryuser(){ // 查询用户列表 list<userdo> userlist = userdao.queryall(); if(collectionutils.isempty(userlist)) { return collections.emptylist(); } // 转化用户列表 list<uservo> uservolist = new arraylist<>(userlist.size()); for(userdo user : userlist) { uservo uservo = new uservo(); uservo.setid(user.getid()); uservo.setname(user.getname()); uservolist.add(uservo); } // 返回用户列表 return uservolist; }
主要收益
- 保证返回的数组和列表不为null, 避免调用函数的空指针判断。
封装函数传入参数
案例一:当传入参数过多时,应封装为参数类
java规范不允许函数参数太多,不便于维护也不便于扩展。
现象描述:
// 修改用户函数 public void modifyuser(long id, string name, string phone, integer age, integer sex, string address, string description) { // 具体实现逻辑 }
建议方案:
// 修改用户函数 public void modifyuser(user user) { // 具体实现内容 } // 用户类 @getter @setter @tostring private class user{ private long id; private string name; private string phone; private integer age; private integer sex; private string address; private string description; }
当传入成组参数时,应封装为参数类
既然参数成组出现,就需要封装一个类去描述这种现象。
现象描述:
// 获取距离函数 public double getdistance(double x1, double y1, double x2, double y2) { // 具体实现逻辑 }
建议方案:
// 获取距离函数 public double getdistance(point point1, point point2) { // 具体实现逻辑 } // 点类 @getter @setter @tostring private class point{ private double x; private double y; }
主要收益
- 封装过多函数参数为类,使函数更便于扩展和维护;
- 封装成组函数参数为类,使业务概念更明确更清晰。
尽量用函数替换匿名内部类的实现
java匿名内部类的优缺点:
在匿名内部类(包括lambda表达式)中可以直接访问外部类的成员,包括类的成员变量、函数的内部变量。正因为可以随意访问外部变量,所以会导致代码边界不清晰。
首先推荐用lambda表达式简化匿名内部类,其次推荐用函数替换复杂的lambda表达式的实现。
案例一:尽量用函数替换匿名内部类(包括lambda表达式)的实现
现象描述:
// 发送结算数据 sendworkersettledata(workerpushdatatype.checker, () -> { date begindate = dateutils.adddays(currdate, -aheaddays); date enddate = dateutils.adddays(currdate, 1); return audittaskdao.statcheckersettledata(begindate, enddate); });
建议方案:
// 发送结算数据 sendworkersettledata(workerpushdatatype.checker, () -> statcheckersettledata(currdate, aheaddays)); // 统计验收员结算数据函数 private list<workersettledata> statcheckersettledata(date currdate, int aheaddays) { date begindate = dateutils.adddays(currdate, -aheaddays); date enddate = dateutils.adddays(currdate, 1); return audittaskdao.statcheckersettledata(begindate, enddate); }
其实,还有一个更简单的办法。在调用函数sendworkersettledata(发送作业员结算数据)之前计算开始日期、结束日期,就直接可以用函数
audittaskdao.statcheckersettledata(begindate, enddate)代替匿名内部类实现。
案例二:拆分复杂匿名内部类实现接口为多个函数类接口
如果一个匿名内部类实现的接口几个函数间关联性不大,可以把这个接口拆分为几个函数式接口,便于使用lambda表达式。
现象描述:
// 清除过期数据 cleanexpireddata("用户日志表", new cleanexpireddataoperator() { @override public list<date> queryexpireddate(integer remaindays) { return userdao.queryexpireddate(remaindays); } @override public void cleanexpireddata(date expireddate) { userdao.cleanexpireddata(expireddate); } }); // 清除过期数据函数 private void cleanexpireddata(string tablename, cleanexpireddataoperator , cleanexpireddataoperator) { // 功能实现代码 } // 清除过期操作接口 interface cleanexpireddataoperator { // 查询过期日期 public list<date> queryexpireddate(integer remaindays); // 清除过期数据 public void cleanexpireddata(date expireddate); }
建议方案:
// 清除过期数据 cleanexpireddata("用户日志表", userdao::queryexpireddate,userdao::cleanexpireddata); // 清除过期数据函数 private void cleanexpireddata(string tablename, queryexpireddateoperator queryexpireddateoperator, cleanexpireddataoperator cleanexpireddataoperator) { // 功能实现代码 } // 查询过期日期接口 interface queryexpireddateoperator { // 查询过期日期 public list<date> queryexpireddate(integer remaindays); } // 清除过期操作接口 interface cleanexpireddataoperator { // 清除过期数据 public void cleanexpireddata(date expireddate); }
主要收益
- 定义函数并指定参数,明确规定了匿名内部类的代码边界;
- 利用lambda表达式简化匿名内部类实现,使代码更简洁。
利用return精简不必要的代码
案例一:删除不必要的if
现象描述:
// 是否通过函数 public boolean ispassed(double passrate) { if (objects.nonnull(passrate) && passrate.compareto(pass_threshold) >= 0) { return true; } return false; }
建议方案:
// 是否通过函数 public boolean ispassed(double passrate) { return objects.nonnull(passrate) && passrate.compareto(pass_threshold) >= 0; }
案例二:删除不必要的else
现象描述:
// 结算工资函数 public double settlesalary(long workid, int workdays) { // 根据是否合格处理 if (isqualified(workid)) { return settlequalifiedsalary(workdays); } else { return settleunqualifiedsalary(workdays); } }
建议方案:
// 结算工资函数 public double settlesalary(long workid, int workdays) { // 根据是否合格处理 if (isqualified(workid)) { return settlequalifiedsalary(workdays); } return settleunqualifiedsalary(workdays); }
案例三:删除不必要的变量
现象描述:
// 查询用户函数 public list<userdo> queryuser(long id, string name) { userquery userquery = new userquery(); userquery.setid(id); userquery.setname(name); list<userdo> userlist = userdao.query(userquery); return userlist; }
建议方案:
// 查询用户函数 public list<userdo> queryuser(long id, string name) { userquery userquery = new userquery(); userquery.setid(id); userquery.setname(name); return userdao.query(userquery); }
主要收益
- 精简不必要的代码,让代码看起来更清爽
利用临时变量优化代码
在一些代码中,经常会看到a.getb().getc()…getn()的写法,姑且叫做“函数的级联调用”,代码健壮性和可读性太差。建议:杜绝函数的级联调用,利用临时变量进行拆分,并做好对象空指针检查。
案例一:利用临时变量厘清逻辑
现象描述:
// 是否土豪用户函数 private boolean isrichuser(user user) { return objects.nonnull(user.getaccount()) && objects.nonnull(user.getaccount().getbalance()) && user.getaccount().getbalance().compareto(rich_threshold) >= 0; }
这是精简代码控的最爱,但是可读性实在太差。
建议方案:
// 是否土豪用户函数 private boolean isrichuser(user user) { // 获取用户账户 useraccount account = user.getaccount(); if (objects.isnull(account)) { return false; } // 获取用户余额 double balance = account.getbalance(); if (objects.isnull(balance)) { return false; } // 比较用户余额 return balance.compareto(rich_threshold) >= 0; }
这个方案,增加了代码行数,但是逻辑更清晰。
有时候,当代码的精简性和可读性发生冲突时,个人更偏向于保留代码的可读性。
案例二:利用临时变量精简代码
现象描述:
// 构建用户函数 public uservo builduser(userdo user) { uservo vo = new uservo(); vo.setid(user.getid()); vo.setname(user.getname()); if (objects.nonnull(user.getaccount())) { vo.setbalance(user.getaccount().getbalance()); vo.setdebt(user.getaccount().getdebt()); } return vo; }
这么写,大约是为了节约一个临时变量把。
建议方案:
// 构建用户函数 public uservo builduser1(userdo user) { uservo vo = new uservo(); vo.setid(user.getid()); vo.setname(user.getname()); useraccount account = user.getaccount(); if (objects.nonnull(account)) { vo.setbalance(account.getbalance()); vo.setdebt(account.getdebt()); } return vo; }
主要收益
- 利用临时变量厘清逻辑,显得业务逻辑更清晰;
- 利用临时变量精简代码,看变量名称即知其义,减少了大量无用代码;
- 如果获取函数比较复杂耗时,利用临时变量可以提高运行效率;
- 利用临时变量避免函数的级联调用,可有效预防空指针异常。
仅保留函数需要的参数
在一些代码中,经常会看到a.getb().getc()…getn()的写法,姑且叫做“函数的级联调用”,代码健壮性和可读性太差。建议:杜绝函数的级联调用,利用临时变量进行拆分,并做好对象空指针检查。
案例一:删除多余的参数
现象描述:
// 修改用户状态函数 private void modifyuserstatus(long userid, integer status, string unused) { usercache.modifystatus(userid, status); userdao.modifystatus(userid, status); } 其中,unused参数是无用参数。 建议方案: // 修改用户状态函数 private void modifyuserstatus(long userid, integer status) { usercache.modifystatus(userid, status); userdao.modifystatus(userid, status); }
案例二:用属性取代对象
现象描述:
// 删除用户函数 private void deleteuser(user user) { usercache.delete(user.getid()); userdao.delete(user.getid()); }
建议方案:
// 删除用户函数 private void deleteuser(long userid) { usercache.delete(userid); userdao.delete(userid); }
建议方案:
调用函数时,参数对象不需要专门构建,而函数使用其属性超过3个,可以不必使用该规则。
主要收益
仅保留函数需要的参数,明确了调用时需要赋值的参数,避免了调用时还要去构造些无用参数。
后记
“众人拾柴火焰高”。如果有更多更好的观点,亦或有更好的代码案例,欢迎大家进行补充说明。笔者希望以此文抛砖引玉,如果最终形成一套完善的java编码规范,善莫大焉。
上一篇: js导入js文件到本地(vue组件中引入js文件并使用)
下一篇: Unity控制指针旋转到指定位置