如何写出优雅整洁易懂的代码?学习这几个方法其实不难!
bigegpt 2024-10-12 06:06 10 浏览
普通的工程师堆砌代码,优秀的工程师优雅代码,卓越的工程师简化代码。如何写出优雅整洁易懂的代码是一门学问,也是软件工程实践里重要的一环。--来自网络
近期,一位Oracle程序员在Hacker News上吐槽自己的工作,引起了热议。
这个工程师的核心痛点是,Oracle经历长期的产品线迭代,代码异常庞大、逻辑复杂,整个代码中充斥着神秘的宏命令。每新增一个特性或者修复BUG,该工程师都需要大量的调研,小心谨慎的进行着日常的工作。而Oracle每次的版本发布都经历数百万次的测试,脑补一下,如噩梦一般。
简洁之术
其实代码规范和静态代码扫描工具能够帮助我们完成很多代码简洁的工作。诸如:注释、命名、方法、异常、单元测试等多个方面。但却无法总结了一些代码简洁最佳实践,其实Java是面向对象语音,而面向对象的特征是封装、继承、多态,巧妙的运用这三大特性、理解Java的一些关键字特性、语音特性、阅读JDK源码,就可以写出相对简洁的代码了。
简化逻辑
- if/else 语法:if语句包含一个布尔表达式,当if语句的布尔表达式值为false时,else语句块会被执行;
- return 关键字:返回一个任意类型的值;
- list.size()>0 表达式:list.size()方法本身是一个返回int类型数值的函数,而与>0组成了一个布尔表达式;
省略无意义赋值
- 局部变量list的数据类型与该方法的返回值类型一致,而多余的变量也将会增加JVM垃圾回收的消耗;
- 局部变量list只是负责接收了mapper.queryList(params)的返回值,而并没有其他逻辑处理;
- 此代码存在于service层和mapper层之间,可以在框架层面进一步抽象,利用注解、java8 default方法等进一步改进;
最小化判断
- 代码中if else的存在只是因为sendMessage函数的第二个参数会有两种情况(成功/失败),尽量让判断最小化;
set方法治理
- 大坨的set方法很影响代码可读性,可封装成特定方法或者使用lombok工具简化代码;
- 局部变量就近声明,增加可读性,局部变量声明和使用地方距离遥远,会导致的读者频繁滑动;
- 可不声明变量尽量不要声明多余的变量,冗余代码;(如date、time两段代码);
巧用JAVA8特性-函数式编程简化代码
JAVA8特性“函数式编程”,使用Lambdas我们能做到什么?
- 遍历集合(List、Map等)、Sum、Max、Min、Avg、Sort、Distinct等等
- 函数接口
- 谓词(Predicate)使用
- 实现Map和Reduce
- 实现事件处理/简化多线程
内、外部循环
上述代码是传统方式的遍历一个List的写法,简单来说主要有3个不足:
- 只能顺序处理list中的数据(process one by one)
- 不能充分利用多核cpu
- 不利于编译器优化(jit)
而使用函数式编程能规避上面的三个问题:
- 不一定需要顺序处理List中的元素,顺序可以不确定
- 可以并行处理,充分利用多核CPU的优势
- 有利于JIT编译器对代码进行优化
- 代码看起来更简洁,完全交给编译器内部循环
default方法
在Java8中,接口中的方法可以被实现,用关键字 default 作为修饰符来标识,接口中被实现的方法叫做 default 方法。使用default方法,当接口发生改变的时候,实现类不需要做改动,所有的子类都会继承 default 方法。
当一个接口扩展另外一个包含默认方法的接口的时候,有以下3种处理方式。
- 完全无视默认方法(直接继承上级接口的默认方法)
- 重新申明默认方法为抽象方法(无实现,具体子类必需再次实现该方法)
- 重新实现默认方法(重写了默认方法的实现,依然是一个默认方法)
日期处理
Java8中新增了LocalDate和LocalTime接口,为什么要搞一套全新的处理日期和时间的API?因为旧的java.util.Date实在是太难用了。
- java.util.Date月份从0开始,一月是0,十二月是11,变态吧!java.time.LocalDate月份和星期都改成了enum,就不可能再用错了。
- java.util.Date和SimpleDateFormatter都不是线程安全的,而LocalDate和LocalTime和最基本的String一样,是不变类型,不但线程安全,而且不能修改。
- java.util.Date是一个“万能接口”,它包含日期、时间,还有毫秒数,如果你只想用java.util.Date存储日期,或者只存储时间,那么,只有你知道哪些部分的数据是有用的,哪些部分的数据是不能用的。在新的Java8中,日期和时间被明确划分为LocalDate和LocalTime,LocalDate无法包含时间,LocalTime无法包含日期。
当然,LocalDateTime才能同时包含日期和时间。
新接口更好用的原因是考虑到了日期时间的操作,经常发生往前推或往后推几天的情况。用java.util.Date配合Calendar要写好多代码,而且一般的开发人员还不一定能写对。
- 1、Clock时钟。Clock类提供了访问当前日期和时间的方法,Clock是时区敏感的,可以用来取代System.currentTimeMillis(),来获取当前的微秒数。某一个特定的时间点也可以使用Instant类(为Final类)来表示,Instant类也可以用来创建老的java.util.Date对象。
Streams与集合
Stream是对集合的包装,通常和lambda一起使用。使用lambdas可以支持许多操作。如 map,filter,limit,sorted,count,min,max,sum,collect等等。 同样,Stream使用懒运算,他们并不会真正地读取所有数据。遇到像getFirst()这样的方法就会结束链式语法,通过下面一系列例子介绍:比如我有个Person类,就是一个简单的pojo, 针对这个对象,我们可能有这样一系列的运算需求。
- .使用foreach输出上述列表
显示工资低于1500的员工(使用stream().filter())
按照年龄排序
将人员姓名存放到TreeSet\set\String中
统计结果summaryStatistics()
去除重复元素,创建新数组
JAVA8 还推出了很多特性,来简化代码。比如String.join函数、Objects类、Base64编码类。
字符串拼接
Objects类
Base64编码
总结
好的代码需要不停的打磨,作为一个优秀的工程师,我们应该严格遵守,每次提交的代码要比迁出的时候更好。经常有人说,作为工程师一定要有团队精神,但这种精神并不是说说而已的,需要实际的行动来体现的。设计模式、JDK的新特性都是我们可以借助的经验,编码完成后思考一下,还可不可以在简化、优化,不要成为一个“作恶”的工程师。
喜欢的小伙伴,请点个关注吧!
相关推荐
- Go语言泛型-泛型约束与实践(go1.7泛型)
-
来源:械说在Go语言中,Go泛型-泛型约束与实践部分主要探讨如何定义和使用泛型约束(Constraints),以及如何在实际开发中利用泛型进行更灵活的编程。以下是详细内容:一、什么是泛型约束?**泛型...
- golang总结(golang实战教程)
-
基础部分Go语言有哪些优势?1简单易学:语法简洁,减少了代码的冗余。高效并发:内置强大的goroutine和channel,使并发编程更加高效且易于管理。内存管理:拥有自动垃圾回收机制,减少内...
- Go 官宣:新版 Protobuf API(go pro版本)
-
原文作者:JoeTsai,DamienNeil和HerbieOng原文链接:https://blog.golang.org/a-new-go-api-for-protocol-buffer...
- Golang开发的一些注意事项(一)(golang入门项目)
-
1.channel关闭后读的问题当channel关闭之后再去读取它,虽然不会引发panic,但会直接得到零值,而且ok的值为false。packagemainimport"...
- golang 托盘菜单应用及打开系统默认浏览器
-
之前看到一个应用,用go语言编写,说是某某程序的windows图形化客户端,体验一下发现只是一个托盘,然后托盘菜单的控制面板功能直接打开本地浏览器访问程序启动的webserver网页完成gui相关功...
- golang标准库每日一库之 io/ioutil
-
一、核心函数概览函数作用描述替代方案(Go1.16+)ioutil.ReadFile(filename)一次性读取整个文件内容(返回[]byte)os.ReadFileioutil.WriteFi...
- 文件类型更改器——GoLang 中的 CLI 工具
-
我是如何为一项琐碎的工作任务创建一个简单的工具的,你也可以上周我开始玩GoLang,它是一种由Google制作的类C编译语言,非常轻量和快速,事实上它经常在Techempower的基准测...
- Go (Golang) 中的 Channels 简介(golang channel长度和容量)
-
这篇文章重点介绍Channels(通道)在Go中的工作方式,以及如何在代码中使用它们。在Go中,Channels是一种编程结构,它允许我们在代码的不同部分之间移动数据,通常来自不同的goro...
- Golang引入泛型:Go将Interface「」替换为“Any”
-
现在Go将拥有泛型:Go将Interface{}替换为“Any”,这是一个类型别名:typeany=interface{}这会引入了泛型作好准备,实际上,带有泛型的Go1.18Beta...
- 一文带你看懂Golang最新特性(golang2.0特性)
-
作者:腾讯PCG代码委员会经过十余年的迭代,Go语言逐渐成为云计算时代主流的编程语言。下到云计算基础设施,上到微服务,越来越多的流行产品使用Go语言编写。可见其影响力已经非常强大。一、Go语言发展历史...
- Go 每日一库之 java 转 go 遇到 Apollo?让 agollo 来平滑迁移
-
以下文章来源于GoOfficialBlog,作者GoOfficialBlogIntroductionagollo是Apollo的Golang客户端Apollo(阿波罗)是携程框架部门研...
- Golang使用grpc详解(golang gcc)
-
gRPC是Google开源的一种高性能、跨语言的远程过程调用(RPC)框架,它使用ProtocolBuffers作为序列化工具,支持多种编程语言,如C++,Java,Python,Go等。gR...
- Etcd服务注册与发现封装实现--golang
-
服务注册register.gopackageregisterimport("fmt""time"etcd3"github.com/cor...
- Golang:将日志以Json格式输出到Kafka
-
在上一篇文章中我实现了一个支持Debug、Info、Error等多个级别的日志库,并将日志写到了磁盘文件中,代码比较简单,适合练手。有兴趣的可以通过这个链接前往:https://github.com/...
- 如何从 PHP 过渡到 Golang?(php转golang)
-
我是PHP开发者,转Go两个月了吧,记录一下使用Golang怎么一步步开发新项目。本着有坑填坑,有错改错的宗旨,从零开始,开始学习。因为我司没有专门的Golang大牛,所以我也只能一步步自己去...
- 一周热门
- 最近发表
- 标签列表
-
- mybatiscollection (79)
- mqtt服务器 (88)
- keyerror (78)
- c#map (65)
- xftp6 (83)
- bt搜索 (75)
- c#var (76)
- xcode-select (66)
- mysql授权 (74)
- 下载测试 (70)
- linuxlink (65)
- pythonwget (67)
- androidinclude (65)
- libcrypto.so (74)
- linux安装minio (74)
- ubuntuunzip (67)
- vscode使用技巧 (83)
- secure-file-priv (67)
- vue阻止冒泡 (67)
- jquery跨域 (68)
- php写入文件 (73)
- kafkatools (66)
- mysql导出数据库 (66)
- jquery鼠标移入移出 (71)
- 取小数点后两位的函数 (73)