我同事说我写代码像写诗

系统管理员 2024-03-26 14:21 39阅读 0赞

把自己平时写代码的习惯跟大家分享一下

###  ###

1.定义配置文件信息

有时候我们为了统一管理会把一些变量放到yml配置文件中

例如

![format_png][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

用 @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

我们来看看上段代码编译完之后的样子

![format_png 1][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

RequiredArgsConstructor：lombok提供

###  ###

3.代码模块化

阿里巴巴Java开发手册中说到每个方法的代码不要超过50行（我没记错的话）

在实际的开发中我们要善于拆分自己的接口或方法, 做到一个方法只处理一种逻辑, 说不定以后某个功能就用到了, 拿来即用

![format_png 2][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

###  ###

4. 抛异常而不是返回

在写业务代码的时候，经常会根据不同的结果返回不同的信息，尽量减少返回，会显得代码比较乱

反例

![format_png 3][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

正例

![format_png 4][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

###  ###

5. 减少不必要的db

尽可能的减少对数据库的查询

举例子

删除一个服务（已下架或未上架的才能删除）

之前有看别人写的代码，会先根据id查询该记录，然后做一些判断

反例

![format_png 5][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

正例

![format_png 6][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

###  ###

6. 不要返回null

反例

![format_png 7][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

正例

![format_png 8][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

别处调用方法时，避免不必要的空指针

###  ###

7. if else

不要太多了if else if

可以试试策略模式代替

###  ###

8. 减少controller业务代码

业务代码尽量放到service层进行处理，后期维护起来也好操作而且美观

反例

![format_png 9][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

正例

![format_png 10][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

###  ###

9. 利用好Idea

目前为止市面上的企业基本都用idea作为开发工具了吧

举一个小例子

idea会对我们的代码进行判断，提出合理的建议

例如：

![format_png 11][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

它推荐我们用lanbda的形式代替

点击replace

![format_png 12][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

###  ###

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;

由此可见其复杂度为On

而hashSet底层采用hashMap作为数据结构进行存储，元素都放到map的key（即链表中）

HashSet<String> set = new HashSet<>(); // 判断a是否在set中 int index = hash(a); return getNode(index) != null

由此可见其复杂度为O1把自己平时写代码的习惯跟大家分享一下

###  ###

1.定义配置文件信息

有时候我们为了统一管理会把一些变量放到yml配置文件中

例如

![format_png 13][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

用 @ConfigurationProperties 代替@Value

使用方法

定义对应字段的实体

使用时注入这个bean

###  ###

2. 用@RequiredArgsConstructor代替@Autowired

我们都知道注入一个bean有三种方式哦（set注入, 构造器注入, 注解注入）,spring推荐我们使用构造器的方式注入Bean

我们来看看上段代码编译完之后的样子

图片上传失败

重试

RequiredArgsConstructor：lombok提供

###  ###

3.代码模块化

阿里巴巴Java开发手册中说到每个方法的代码不要超过50行（我没记错的话）

在实际的开发中我们要善于拆分自己的接口或方法, 做到一个方法只处理一种逻辑, 说不定以后某个功能就用到了, 拿来即用

![format_png 14][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

###  ###

4. 抛异常而不是返回

在写业务代码的时候，经常会根据不同的结果返回不同的信息，尽量减少返回，会显得代码比较乱

反例

![format_png 3][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

正例

![format_png 4][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

###  ###

5. 减少不必要的db

尽可能的减少对数据库的查询

举例子

删除一个服务（已下架或未上架的才能删除）

之前有看别人写的代码，会先根据id查询该记录，然后做一些判断

反例

![format_png 15][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

正例

![format_png 6][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

###  ###

6. 不要返回null

反例

![format_png 16][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

正例

![format_png 17][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

别处调用方法时，避免不必要的空指针

###  ###

7. if else

不要太多了if else if

可以试试策略模式代替

###  ###

8. 减少controller业务代码

业务代码尽量放到service层进行处理，后期维护起来也好操作而且美观

反例

![format_png 18][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

正例

![format_png 10][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

###  ###

9. 利用好Idea

目前为止市面上的企业基本都用idea作为开发工具了吧

举一个小例子

idea会对我们的代码进行判断，提出合理的建议

例如：

![format_png 11][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

它推荐我们用lanbda的形式代替

点击replace

![format_png 12][]

编辑切换为居中

添加图片注释，不超过 140 字（可选）

###  ###

10. 阅读源码

###  ###

11. 设计模式

23种设计模式，要尝试代码中运用设计模式思想，写出的代码即规范又美观还高大上哈哈。

###  ###

12. 拥抱新知识

###  ###

13. 基础问题

map遍历

optional 判空

递归

> 大数据量的递归时，避免在递归方法里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;

由此可见其复杂度为On

而hashSet底层采用hashMap作为数据结构进行存储，元素都放到map的key（即链表中）

HashSet<String> set = new HashSet<>(); // 判断a是否在set中 int index = hash(a); return getNode(index) != null

由此可见其复杂度为O1

[format_png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/1b42a60ad5244219a528a9cda62bc627.png
[format_png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/9357cc9346aa4eaaae5480b5253e4d29.png
[format_png 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/885392f2eb11441ea0cca2e9ead271d2.png
[format_png 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/d8faf6b3b2d74bdcb9e7199d093d99ef.png
[format_png 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/f92a0f963441419ea741ddbe6f3fc28e.png
[format_png 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/fae94f95c2e449b5a6f3e72098fa9a3f.png
[format_png 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/849796a3042b43438251dc383a3658e8.png
[format_png 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/e39ae3078981413b88dc688cb08f9ea5.png
[format_png 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/08a4998cf338499a8321aa2693a0efe4.png
[format_png 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/3ed63e9f3b0249cfaa2f6cb14d94929e.png
[format_png 10]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/fdc89f0e6ecf4f00905675aaae9a71a1.png
[format_png 11]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/6cc059148ac9472abed3b988f129290b.png
[format_png 12]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/93a8679a735246a1860275fc9c4a7275.png
[format_png 13]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/74887ecd772541228714ecf2618c802c.png
[format_png 14]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/413297b958d942fe8a088c011ae15951.png
[format_png 15]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/12f67fe2d1da46faa208fa881b0bdc2f.png
[format_png 16]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/1e043d6ef995411c9abb404d9ebe28d6.png
[format_png 17]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/a7dc4436edc5475394733225b977ded2.png
[format_png 18]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/db99f519913848d087aa6309c472289c.png