提升Java代码质量：软件工程基石与最佳实践

需积分: 0 58 浏览量更新于2024-06-22 收藏 910KB PDF 举报

在"如何写好代码的一些建议（Java版）"这篇文章中，作者强调了在软件工程中提升代码质量的重要性，特别是在面对严峻的商业环境和安全挑战时。任正非在华为的讲话中提到了五个关键领域，这些领域直接关系到代码的质量和产品的可信度： 1. 安全性（Security）：确保产品具有抵御攻击的能力，保护数据的机密性、完整性和可用性，这是在面对外部压力如美国的抵制时尤为重要的。 2. 韧性（Resilience）：设计系统能应对攻击并保持预定运行状态，包括在遭受攻击时的降级及快速恢复功能。 3. 隐私性（Privacy）：尊重隐私法规，用户应能控制其数据的使用，且信息政策透明，确保数据的保护。 4. 可靠性和可用性（Reliability&Availability）：产品需长期无故障运行，具备快速恢复和自我管理能力，提供一致的服务。 5. 软件工程能力提升：每个开发者都需积极参与，从编码质量抓起，遵循编程规范，运用设计原则，如命名规范、函数长度限制、有效日志记录、线程安全、数据结构与算法、异常处理、事务管理以及单一职责和开闭原则等。作者强调，高质量的代码就像建筑基石，是构建可信产品必不可少的基础。通过遵循公司内部的编程规范，熟练使用工具和技术，编写出清晰、规范、可读性强且安全的代码，是提升软件工程能力的关键。同时，理解架构的核心要素，确保在性能、功能和扩展性之间做出明智的权衡，设计高内聚低耦合的模块和接口，是实现这一目标的重要步骤。本文提供的是一份实用的指南，帮助Java开发者提升代码编写技能，遵循最佳实践，以打造既安全又可靠的软件产品，从而支撑企业的长期发展和生存。

注意不要因为日志输出而引起报错

2.3.5、讲故事

这个问题典型的表现就是把各种代码逻辑都以日志的形式呈现了出来。

2.3.6、日志跟踪

为了方便日志跟踪，最少给日志配上时间戳、级别、线程名，或者其他能够有效识别的信息。

比如配置上traceId和spanId方便跟踪。

线程名XNIO-2一看就知道是web服务undertow开启的。

2.3.7、输出堆栈

异常堆栈信息对于问题排查是非常重要的。

下面这种打印方式，e被当作普通对象传入参数中，只会按照e.getMessage方法输出，并不会打印全部

堆栈信息。

public static void methodE() {

 Map<String, String> map = new HashMap<>();

 map.put("a", "1");

 map.put("b", "2");

 map.put("c", "3");

 log.info("没必要把map或者对象通过JSON转成String再打印: {}" ,

JSON.toJSONString(map));

}

public static void methodE() {

 User user = null;

 log.info("调用user中的任何方法都会出现空指针异常: {}", user.toString());

 log.info("直接打印user即可: {}", user);

}

private static void method1(String name) {

 User user = new User();

 log.info("把user对象的name设置成:{}", name);

 user.setName(name);

 log.info("当name等于小王时，执行methodA，否则执行methodB");

 if (Objects.equals("小王", name)) {

   methodA();

 } else {

   methodB();

 }

}

<pattern>%date %level [%X{traceId}/%X{spanId}] [%thread] %logger{10}

[%file:%line] %msg%n</pattern>

log.error("fee config calculate failure, error message：{}, request param：{}",

e, request.toString());

应该修改为

2.3.8、其他基本要求

1、请按照正确的日志级别进行输出，debug、info、warn、error应该要区分清楚。

2、使用占位符的方式输出日志，占位符比使用String拼接要高效。

3、日志输出尽量使用英文，可以有效地减少日志存储大小，也更加符合国际化标准。

以下两条来自阿里规范中的说明

4、大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日

志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？

5、注意日志输出的级别，error级别只记录系统逻辑出错、异常或者重要的错误信息。

6、不要直接使用日志系统的（log4j、logback）API，请使用日志框架SLF4J中的API。

2.4、线程

2.4.1、线程池

池化思想、复用思想这是提升性能的一种有效手段，常见的有线程池、连接池、对象池，但是他们都存

在一个相同的问题就是池子的容量，在JDK1.5时提供的几种线程池，默认情况下都没有控制，

newFixedThreadPool、newSingleThreadExecutor属于几乎无限大队列数，

newCachedThreadPool、newScheduledThreadPool属于几乎无限大线程数，所以一般我们要根据实

际情况自己构建合理的线程池，另外了为了方便排查问题，要给线程池起一个有意义的名称。

2.4.2、线程安全

提起线程就一定绕不开线程安全的问题，现在几乎都在使用Spring框架，我们知道SpringBean对象默认

都是单例的，是线程不安全的，但是由于三层架构的方式，一般我们注入的SpringBean实例，像

Contorller、Service、Dao这些都是无状态的，自然也就不存在线程安全的问题，所以搞清楚是否线程

安全的关键，不仅仅是判断资源是否共享，还要看看共享的资源是否是有状态的。

JDK在此方面也提供了很多线程安全的类，我们应该清楚它们的使用场景。

时间

使用Instant代替Date，LocalDateTime代替Calendar，DateTimeFormatter代

替SimpleDateFormat。

数值

JDK1.5提供了很多Atomic开头的类，这些类大多数都是通过cas的方式实现原子操作。

集合

关于集合的线程安全类有很多，主要差别在于性能和使用场景上。

log.error("fee config calculate failure, error message：{}, request param：{}",

e.getMessage(), request.toString(), e);

Map

List

前两种方式与map一样都是通过synchronized关键字来实现

这里要特别注意CopyOnWriteArrayList的使用场景，对于读多写少的场景CopyOnWriteArrayList效率

非常高，但如果是读少写多的情况下，CopyOnWriteArrayList的效率则十分低下，还不如直接使用

Collections.synchronizedList(newArrayList<>())

Set

2.4.3、线程并发

除了线程安全之外，就要考虑并发方面的问题了，并发有可能造成一段代码的处理能力急剧下滑，如何

利用多线程的并行处理能力解决并发效率问题，也是非常关键的地方。

常见的解决方式包括：无锁化（cas）、分段锁（每个线程分别锁一小段，减少冲突）、读写锁、写时复

制、伪共享等。

其实现在的JDK已经对synchronized进行了大量的优化，效率也并没有想象的那么差了，并且

synchronized在保证线程安全方面足够的简单，在涉及到资金相关操作时，更加稳妥，不容易出

错。

悲观锁遵循一锁、二判、三更新、四释放的原则。

// 这两种都是通过使用synchronized关键字来实现，效率都不高

Collections.synchronizedMap(new HashMap<>());

Map m = new Hashtable();

// ConcurrentHashMap一开始采用分段锁实现，之后在JDK对synchronized优化后，又改成

synchronized+分段锁实现

Map map = new ConcurrentHashMap();

// 不可变的方式，禁止写的操作，也算是从根源上杜绝线程不安全的可能。。。如果创建后需要禁止写入，

则可以使用这种方式

Collections.unmodifiableMap(new HashMap<>());

// 有序的、线程安全的Map

new ConcurrentSkipListMap<>();

Collections.synchronizedList(new ArrayList<>());

List list = new Vector();

List safeList = new CopyOnWriteArrayList();

Collections.unmodifiableList(new ArrayList<>());

// 两种方式几乎没有什么区别newKeySet时JDK1.8时提供的，newSetFromMap是JDK1.6时提供的，本质

都是通过ConcurrentHashMap实现的

ConcurrentHashMap.newKeySet();

Collections.newSetFromMap(new ConcurrentHashMap<>());

// 写时复制的set，同样需要注意使用场景，只有读多写少的情况才适用

new CopyOnWriteArraySet();

//不可变的

Collections.unmodifiableSet(new HashSet<>());

//有序的set集合，综合了读写性能，如果读写都差不多的情况下，可以使用它

new ConcurrentSkipListSet();

剩余70页未读，继续阅读

码拉松

粉丝: 3w+
资源: 2

提升Java代码质量：软件工程基石与最佳实践

java代码编写建议

如何编写高质量的代码(百个建议)

java编写建议（转载）

如何写好Java代码

44条Java代码优化建议

写好Java代码的30条经验总结.docx

Java代码编写的30条建议

java代码编写的30条建议

写一个坦克大战java代码

如何写出高深java代码

最新资源