Java编程——编写高质量代码的思考

简介:                                                  前言       最近在看《代码大全》,可以说是一本软件开发的百科全书,特别厚,但是干货也很多。

                                                 前言

       最近在看《代码大全》,可以说是一本软件开发的百科全书,特别厚,但是干货也很多。平时写代码,代码规范是一个最低的要求(很多老代码连最低要求都达不到),为什么要这样规定代码要这么写,而不是那么写?这是一个值得深究的问题。而不是说我照着代码规范写代码就算完了,高质量的代码是一个专业工程师的追求。要知其然知其所以然,最近写发票解析的代码,因为涉及带解析PDF的算法,复杂度比较高,所以花了很多时间在重构,学以致用的时候积累了一些心得。

信息隐藏原则

       信息隐藏是面向对象设计的一个原则,是对封装和模块化的一个更高维度的概括。从Java的整个访问限制设计就体现了信息隐藏的原则,各种访问修饰符:public,protect,private,在类设计的时候,我们就要决定什么暴露给外部,什么隐藏起来。

举一个例子下面的代码表示一个有自增ID的Person类。

上面的类设计有什么问题呢?它违反了信息隐藏的原则,直接将ID分配的方式暴露了,这会给后面的维护带来很多问题:当你想给id的范围做出限制的时候怎么办?当你在所有代码中使用++G_MAX_ID分配ID时突然需要修改ID分配的算法怎么办?是不是需要去改所有++G_MAX_ID出现的地方?更好的设计是将ID的分配算法隐藏起来。

咋一看只是将++G_MAX_ID写到一个方法里面而已,但是它隐藏了ID分配的算法,让调用者不需要关心里面的实现,同时控制了变化,不管ID分配算法怎么变,都不会影响其他的代码。调用者了解的信息越多,受到的影响就越大,信息隐藏可以降低复杂度,控制变化的范围。

上面的例子只是信息隐藏的一个简单应用,下面我们来举几个其他的应用例子:

为什么不推荐使用魔法值(即未经定义的常量)?:这个明显违反了信息隐藏的原则,当你将字面量直接写在代码里面时,就将信息直接暴露了,后面需要修改的时候,一旦少改了某个地方的字面量,bug就出现了。

循环依赖(即A调用B,B调用A的情况):类或方法之间的循环依赖会破坏信息隐藏,一个很直接的影响就是在测试的时候,A,B都需要同时准备好才能进行测试,而无法mock任意一方。

使用全局变量:这个就不用说了,所有人都可以访问你的时候信息就暴露无疑了,全局变量能不用就不用。

考虑性能损失:有时候我们为了一些性能上的考虑就破坏信息隐藏原则,将一些变量全局化,这样性能提高得不多,维护成本却上升不少,完全是得不偿失。

最后总结一下信息隐藏的好处:

隐藏信息即隐藏了复杂度,降低了编程的负担。

隐藏信息即隐藏了底层变化,以便于在局部控制变化。

一些不太常见的编程技巧

函数(function)与过程(procedure)的选择

我们先来看看函数与过程区别:

Function:有返回值的方法

Procedure:没有返回值的方法

平时我们编程其实没有太区别函数与过程,什么时候用函数,什么时候用过程其实没有过多的考虑,感觉都可以用。一个选择的规则就是当你的方法的目的是想返回跟你方法名称相符的值的时候用函数,否则用过程

举个例子,我看过很多XXProcessor接口里面的方法都是XX process(),严格来讲,这样的命名是不符合上面的规则的,process是一个没有含义的命名,但是却有返回值,如果没有返回值那它的命名才是合理的。

当然了,上面的规则仅供参考,世事无绝对,具体情况具体分析,当你不清楚用函数还是用过程的时候,可以参考这个规则。

使用boolean值来给程序做注释

相信大家看到一个if语句有很多条件的时候都会特别头痛,因为很难理解。例如下面的例子:

但如果换成下面的写法,用boolean值的名字来给if语句注释,看起来就很好理解了。

                                                  总结

       怎么写高质量的代码是一个很大的话题,这里只是抛砖引玉,其实面向对象设计的很多原则都能够给我们写代码的时候提供指导,写代码的时候要时刻记得学以致用,而不是敷衍了事,专业的软件工程师必然要能写得一手好代码。

      如有不同意见,欢迎留言探讨,如对本文感兴趣,欢迎关注笔者,笔者持续更新。

相关文章
|
1天前
|
存储 安全 Java
Java并发编程中的高效数据结构:ConcurrentHashMap解析
【4月更文挑战第25天】在多线程环境下,高效的数据访问和管理是至关重要的。Java提供了多种并发集合来处理这种情境,其中ConcurrentHashMap是最广泛使用的一个。本文将深入分析ConcurrentHashMap的内部工作原理、性能特点以及它如何在保证线程安全的同时提供高并发性,最后将展示其在实际开发中的应用示例。
|
2天前
|
Java API 调度
[Java并发基础]多进程编程
[Java并发基础]多进程编程
|
2天前
|
Java API 调度
[AIGC] 深入理解Java并发编程:从入门到进阶
[AIGC] 深入理解Java并发编程:从入门到进阶
|
2天前
|
前端开发 Java 测试技术
Java从入门到精通:4.1.1参与实际项目,锻炼编程与问题解决能力
Java从入门到精通:4.1.1参与实际项目,锻炼编程与问题解决能力
|
2天前
|
SQL Java 数据库连接
Java从入门到精通:2.3.2数据库编程——了解SQL语言,编写基本查询语句
Java从入门到精通:2.3.2数据库编程——了解SQL语言,编写基本查询语句
|
2天前
|
SQL Java 数据库连接
Java从入门到精通:2.3.1数据库编程——学习JDBC技术,掌握Java与数据库的交互
ava从入门到精通:2.3.1数据库编程——学习JDBC技术,掌握Java与数据库的交互
|
2天前
|
IDE Java 开发工具
Java从入门到精通:1.3.1实践编程巩固基础知识
Java从入门到精通:1.3.1实践编程巩固基础知识
|
6天前
|
IDE Java 物联网
《Java 简易速速上手小册》第1章:Java 编程基础(2024 最新版)
《Java 简易速速上手小册》第1章:Java 编程基础(2024 最新版)
13 0
|
7天前
|
安全 Java 开发者
Java并发编程:深入理解Synchronized关键字
【4月更文挑战第19天】 在Java多线程编程中,为了确保数据的一致性和线程安全,我们经常需要使用到同步机制。其中,`synchronized`关键字是最为常见的一种方式,它能够保证在同一时刻只有一个线程可以访问某个对象的特定代码段。本文将深入探讨`synchronized`关键字的原理、用法以及性能影响,并通过具体示例来展示如何在Java程序中有效地应用这一技术。
|
8天前
|
安全 Java 调度
Java并发编程:深入理解线程与锁
【4月更文挑战第18天】本文探讨了Java中的线程和锁机制,包括线程的创建(通过Thread类、Runnable接口或Callable/Future)及其生命周期。Java提供多种锁机制,如`synchronized`关键字、ReentrantLock和ReadWriteLock,以确保并发访问共享资源的安全。此外,文章还介绍了高级并发工具,如Semaphore(控制并发线程数)、CountDownLatch(线程间等待)和CyclicBarrier(同步多个线程)。掌握这些知识对于编写高效、正确的并发程序至关重要。