怎么写出更优质的代码?
大家好,我是鱼皮。今天给大家分享一些比较基础的编程小方法和经验,希望能帮助大家写出更优质的代码。
注:虽然以下文章的代码部分以 Java Spring Boot 框架来举例,但是很多方法是通用的
原文链接:blog.csdn.net/weixin_44912855/article/details/120866194
1. 定义配置文件信息
有时候我们为了统一管理会把一些变量放到 yml 配置文件中
例如
用 @ConfigurationProperties 代替 @Value
使用方法
定义对应字段的实体
@Data
// 指定前缀
@ConfigurationProperties(prefix = "developer")
@Component
public class DeveloperProperty {
private String name;
private String website;
private String qq;
private String phoneNumber;
}
使用时注入这个bean
@RestController
@RequiredArgsConstructor
public class PropertyController {
final DeveloperProperty developerProperty;
@GetMapping("/property")
public Object index() {
return developerProperty.getName();
}
}
2. 用@RequiredArgsConstructor代替@Autowired
我们都知道注入一个 bean 有三种方式哦(set 注入, 构造器注入, 注解注入),Spring 推荐我们使用构造器的方式注入 Bean,我们来看看上段代码编译完之后的样子
RequiredArgsConstructor:lombok 提供
3.代码模块化
阿里巴巴 Java 开发手册中说到每个方法的代码不要超过 50 行(我没记错的话),手册:https://www.yoodb.com/deployment/handbook/alibaba-java-specification.html
,在实际的开发中我们要善于拆分自己的接口或方法, 做到一个方法只处理一种逻辑, 说不定以后某个功能就用到了, 拿来即用。
4. 抛异常而不是返回
在写业务代码的时候,经常会根据不同的结果返回不同的信息,尽量减少返回,会显得代码比较乱。
反例
正例
5. 减少不必要的db
尽可能的减少对数据库的查询。
举例子
删除一个服务(已下架或未上架的才能删除),之前有看别人写的代码,会先根据 id 查询该记录,然后做一些判断。
反例
正例
6. 不要返回 null
反例
正例
别处调用方法时,避免不必要的空指针
7. if else
不要太多了if else if,可以试试策略模式代替
8. 减少 controller 业务代码
业务代码尽量放到service层进行处理,后期维护起来也好操作而且美观。
反例
正例
9. 利用好Idea
目前为止市面上的企业基本都用 idea 作为开发工具了吧。
举一个小例子
idea 会对我们的代码进行判断,提出合理的建议
例如
它推荐我们用 lambda 的形式代替,点击 replace
10. 阅读源码
一定要养成阅读源码的好习惯包括优秀的开源项目 GitHub 上 stars:>1000, 会从中学好好多知识包括其对代码的设计思想以及高级 API,面试加分(好多面试官习惯问源码相关的知识。
11. 设计模式
23 种设计模式,要尝试代码中运用设计模式思想,写出的代码即规范又美观还高大上哈哈。
12. 拥抱新知识
工作年限少的程序员,要多学习自己认知之外的知识,不能每天 crud,有机会就多用用有点难度的知识,没有机会(项目较传统),可以自己下班多些相关 demo 练习
13. 基础问题
map遍历
HashMap<String, String> map = new HashMap<>();
map.put("name", "du");
for (String key : map.keySet()) {
String value = map.get(key);
}
map.forEach((k, v) -> {
});
// 推荐
for (Map.Entry<String, String> entry : map.entrySet()) {
}
optional 判空
//获取子目录列表
public List<CatalogueTreeNode> getChild(String pid) {
if (V.isEmpty(pid)) {
pid = BasicDic.TEMPORARY_DIRECTORY_ROOT;
}
CatalogueTreeNode node = treeNodeMap.get(pid);
return Optional.ofNullable(node)
.map(CatalogueTreeNode::getChild)
.orElse(Collections.emptyList());
}
递归
大数据量的递归时,避免在递归方法里 new 对象,可以试试把对象当作方法参数进行传递使用
注释
类、接口方法、注解、较复杂的方法,注释都要写而且要写清楚, 有时候写注释不是给别人看的 而是给自己看的。
14. 判断元素是否存在
使用 hashSet 而不是 list。
list 判断一个元素是否存在的代码:
ArrayList<String> list = new ArrayList<>();
// 判断a是否在list中
for (int i = 0; i < list.size(); i++)
if ("a".equals(elementData[i]))
return i;
由此可见其复杂度为O(n),而 hashSet 底层采用 hashMap 作为数据结构进行存储,元素都放到 map 的 key(即链表中)
HashSet<String> set = new HashSet<>();
// 判断a是否在set中
int index = hash(a);
return getNode(index) != null
时间复杂度为O(1)。
最后,欢迎学编程的朋友们加入鱼皮的 编程知识星球 ,鱼皮会 1 对 1 解决你的问题,直播带你做出项目、为你定制学习计划和求职指导,还能获取海量编程学习资源,和上万名学编程的同学共享知识、交流进步。
往期推荐