Java代码写的很丑？那你得看看这篇——代码精简之道
古语有云：
道为术之灵，术为道之体；以道统术，以术得道。
其中：“道”指“规律、道理、理论”，“术”指“方法、技巧、技术”。意思是：“道”是“术”的灵魂，“术”是“道”的肉体；可以用“道”来统管“术”，也可以从“术”中获得“道”。
在拜读大佬“孤尽”的文章《Code Review是苦涩但有意思的修行》时，感受最深的一句话就是：“优质的代码一定是少即是多的精兵原则”，这就是大佬的代码精简之“道”。
工匠追求“术”到极致，其实就是在寻“道”，且离悟“道”也就不远了，亦或是已经得道，这就是“工匠精神”——一种追求“以术得道”的精神。如果一个工匠只满足于“术”，不能追求“术”到极致去悟“道”，那只是一个靠“术”养家糊口的工匠而已。作者根据多年来的实践探索，总结了大量的 Java 代码精简之“术”，试图阐述出心中的 Java 代码精简之“道”。
利用语法
1.1.利用三元表达式
普通：
String title;if (isMember(phone)) { title = "会员";} else { title = "游客";}
精简：
String title = isMember(phone) ? "会员" : "游客";
注意：对于包装类型的算术计算，需要注意避免拆包时的空指针问题。
1.2.利用 for-each 语句
从 Java 5 起，提供了 for-each 循环，简化了数组和集合的循环遍历。 for-each 循环允许你无需保持传统 for 循环中的索引就可以遍历数组，或在使用迭代器时无需在 while 循环中调用 hasNext 方法和 next 方法就可以遍历集合。
普通：
double[] values = ...;
for(int i = 0; i < values.length; i++) {
double value = values[i];
// TODO: 处理value
}
List valueList = ...;
Iterator iterator = valueList.iterator();
while (iterator.hasNext()) {
Double value = iterator.next();
// TODO: 处理value
｝
精简：
double[] values = ...;
for(double value : values) {
// TODO: 处理value
}
List valueList = ...;
for(Double value : valueList) {
// TODO: 处理value
｝
1.3.利用 try-with-resource 语句
所有实现 Closeable 接口的“资源”，均可采用 try-with-resource 进行简化。
普通：
BufferedReader reader = null;
try {
reader = new BufferedReader(new FileReader("cities.csv"));
String line;
while ((line = reader.readLine()) != null) {
// TODO: 处理line
}
} catch (IOException e) {
log.error("读取文件异常", e);
} finally {
if (reader != null) {
try {
reader.close();
} catch (IOException e) {
log.error("关闭文件异常", e);
}
}
｝
精简：
try (BufferedReader reader = new BufferedReader(new FileReader("test.txt"))) {
String line;
while ((line = reader.readLine()) != null) {
// TODO: 处理line
}
} catch (IOException e) {
log.error("读取文件异常", e);
｝
1.4.利用 return 关键字
利用 return 关键字，可以提前函数返回，避免定义中间变量。
普通：
public static boolean hasSuper(@NonNull List userList) {
boolean hasSuper = false;
for (UserDO user : userList) {
if (Boolean.TRUE.equals(user.getIsSuper())) {
hasSuper = true;
break;
}
}
return hasSuper;
}
精简：
public static boolean hasSuper(@NonNull List userList) {
for (UserDO user : userList) {
if (Boolean.TRUE.equals(user.getIsSuper())) {
return true;
}
}
return false;
}
1.5.利用 static 关键字
利用 static 关键字，可以把字段变成静态字段，也可以把函数变为静态函数，调用时就无需初始化类对象。
普通：
public final class GisHelper {
public double distance(double lng1, double lat1, double lng2, double lat2) {
// 方法实现代码
}
}
GisHelper gisHelper = new GisHelper();
double distance = gisHelper.distance(116.178692D, 39.967115D, 116.410778D, 39.899721D);
精简：
public final class GisHelper {
public static double distance(double lng1, double lat1, double lng2, double lat2) {
// 方法实现代码
}
}
double distance = GisHelper.distance(116.178692D, 39.967115D, 116.410778D, 39.899721D);
1.6.利用 lambda 表达式
Java 8 发布以后，lambda 表达式大量替代匿名内部类的使用，在简化了代码的同时，更突出了原有匿名内部类中真正有用的那部分代码。
普通：
new Thread(new Runnable() { public void run() { // 线程处理代码 }}).start();
精简：
new Thread(() -> { // 线程处理代码}).start();
1.7.利用方法引用
方法引用（::），可以简化 lambda 表达式，省略变量声明和函数调用。
普通：
Arrays.sort(nameArray, (a, b) -> a.compareToIgnoreCase(b));
List userIdList = userList.stream()
.map(user -> user.getId())
.collect(Collectors.toList());
精简：
Arrays.sort(nameArray, String::compareToIgnoreCase);
List userIdList = userList.stream()
.map(UserDO::getId)
.collect(Collectors.toList());
1.8.利用静态导入
静态导入（import static），当程序中大量使用同一静态常量和函数时，可以简化静态常量和函数的引用。
普通：
List areaList = radiusList.stream().map(r -> Math.PI * Math.pow(r, 2)).collect(Collectors.toList());
精简：
import static java.lang.Math.PI;
import static java.lang.Math.pow;
import static java.util.stream.Collectors.toList;
List areaList = radiusList.stream().map(r -> PI * pow(r, 2)).collect(toList());
注意：静态引入容易造成代码阅读困难，所以在实际项目中应该警慎使用。
1.9.利用 unchecked 异常
Java 的异常分为两类：Checked 异常和 Unchecked 异常。Unchecked 异常继承了RuntimeException ，特点是代码不需要处理它们也能通过编译，所以它们称作 Unchecked 异常。利用 Unchecked 异常，可以避免不必要的 try-catch 和 throws 异常处理。
普通：
@Service
public class UserService {
public void createUser(UserCreateVO create, OpUserVO user) throws BusinessException {
checkOperatorUser(user);
...
}
private void checkOperatorUser(OpUserVO user) throws BusinessException {
if (!hasPermission(user)) {
throw new BusinessException("用户无操作权限");
}
...
}
...
}
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private UserService userService;
@PostMapping("/createUser")
public Result createUser(@RequestBody @Valid UserCreateVO create, OpUserVO user) throws BusinessException {
userService.createUser(create, user);
return Result.success();
}
...
}
精简：
@Service
public class UserService {
public void createUser(UserCreateVO create, OpUserVO user) {
checkOperatorUser(user);
...
}
private void checkOperatorUser(OpUserVO user) {
if (!hasPermission(user)) {
throw new BusinessRuntimeException("用户无操作权限");
}
...
}
...
}
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private UserService userService;
@PostMapping("/createUser")
public Result createUser(@RequestBody @Valid UserCreateVO create, OpUserVO user) {
userService.createUser(create, user);
return Result.success();
}
...
}
利用注解
2.1.利用 Lombok 注解
Lombok 提供了一组有用的注解，可以用来消除Java类中的大量样板代码。
普通：
public class UserVO {
private Long id;
private String name;
public Long getId() {
return this.id;
}
public void setId(Long id) {
this.id = id;
}
public String getName() {
return this.name;
}
public void setName(String name) {
this.name = name;
}
...
}
精简：
@Getter
@Setter
@ToString
public class UserVO {
private Long id;
private String name;
...
}
2.2.利用 Validation 注解
普通：
@Getter@Setter@ToStringpublic class UserCreateVO {
@NotBlank(message = "用户名称不能为空")
private String name;
@NotNull(message = "公司标识不能为空")
private Long companyId;
...
}
@Service@Validatedpublic class UserService {
public Long createUser(@Valid UserCreateVO create) {
// TODO: 创建用户
return null;
}
}
精简：
@Getter
@Setter
@ToString
public class UserCreateVO {
@NotBlank(message = "用户名称不能为空")
private String name;
@NotNull(message = "公司标识不能为空")
private Long companyId;
...
}
@Service
@Validated
public class UserService {
public Long createUser(@Valid UserCreateVO create) {
// TODO: 创建用户
return null;
}
}
2.3.利用 @NonNull 注解
Spring 的 @NonNull 注解，用于标注参数或返回值非空，适用于项目内部团队协作。只要实现方和调用方遵循规范，可以避免不必要的空值判断，这充分体现了阿里的“新六脉神剑”提倡的“因为信任，所以简单”。
普通：
public List queryCompanyUser(Long companyId) {
// 检查公司标识
if (companyId == null) {
return null;
}
// 查询返回用户
List userList = userDAO.queryByCompanyId(companyId);
return userList.stream().map(this::transUser).collect(Collectors.toList());
}
Long companyId = 1L;
List userList = queryCompanyUser(companyId);
if (CollectionUtils.isNotEmpty(userList)) {
for (UserVO user : userList) {
// TODO: 处理公司用户
}
}
精简：
public @NonNull List queryCompanyUser(@NonNull Long companyId) {
List userList = userDAO.queryByCompanyId(companyId);
return userList.stream().map(this::transUser).collect(Collectors.toList());
}
Long companyId = 1L;
List userList = queryCompanyUser(companyId);
for (UserVO user : userList) {
// TODO: 处理公司用户
}
2.4.利用注解特性
注解有以下特性可用于精简注解声明：
1、当注解属性值跟默认值一致时，可以删除该属性赋值；
2、当注解只有value属性时，可以去掉value进行简写；
3、当注解属性组合等于另一个特定注解时，直接采用该特定注解。
普通：
@Lazy(true);
@Service(value = "userService")
@RequestMapping(path = "/getUser", method = RequestMethod.GET)
精简：
@Lazy
@Service("userService")
@GetMapping("/getUser")
利用泛型
3.1.泛型接口
在 Java 没有引入泛型前，都是采用 Object 表示通用对象，最大的问题就是类型无法强校验并且需要强制类型转换。
普通：
public interface Comparable {
public int compareTo(Object other);
}
@Getter
@Setter
@ToString
public class UserVO implements Comparable {
private Long id;
@Override
public int compareTo(Object other) {
UserVO user = (UserVO)other;
return Long.compare(this.id, user.id);
}
}
精简：
public interface Comparable {
public int compareTo(T other);
}
@Getter
@Setter
@ToString
public class UserVO implements Comparable {
private Long id;
@Override
public int compareTo(UserVO other) {
return Long.compare(this.id, other.id);
}
}
3.2.泛型类
普通：
@Getter
@Setter
@ToString
public class IntPoint {
private Integer x;
private Integer y;
}
@Getter
@Setter
@ToString
public class DoublePoint {
private Double x;
private Double y;
}
精简：
@Getter
@Setter
@ToString
public class Point {
private T x;
private T y;
}
3.3.泛型方法
普通：
public static Map newHashMap(String[] keys, Integer[] values) {
// 检查参数非空
if (ArrayUtils.isEmpty(keys) || ArrayUtils.isEmpty(values)) {
return Collections.emptyMap();
}
// 转化哈希映射
Map map = new HashMap<>();
int length = Math.min(keys.length, values.length);
for (int i = 0; i < length; i++) {
map.put(keys[i], values[i]);
}
return map;
}
精简：
public static Map newHashMap(K[] keys, V[] values) {
// 检查参数非空
if (ArrayUtils.isEmpty(keys) || ArrayUtils.isEmpty(values)) {
return Collections.emptyMap();
}
// 转化哈希映射
Map map = new HashMap<>();
int length = Math.min(keys.length, values.length);
for (int i = 0; i < length; i++) {
map.put(keys[i], values[i]);
}
return map;
｝
利用自身方法
4.1.利用构造方法
构造方法，可以简化对象的初始化和设置属性操作。对于属性字段较少的类，可以自定义构造方法。
普通：
@Getter
@Setter
@ToString
public class PageDataVO {
private Long totalCount;
private List dataList;
}
PageDataVO pageData = new PageDataVO<>();
pageData.setTotalCount(totalCount);
pageData.setDataList(userList);
return pageData;
...
精简：
@Getter
@Setter
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class PageDataVO {
private Long totalCount;
private List dataList;
}
return new PageDataVO<>(totalCount, userList);
注意：如果属性字段被替换时，存在构造函数初始化赋值问题。比如把属性字段title替换为 nickname ，由于构造函数的参数个数和类型不变，原有构造函数初始化语句不会报错，导致把原title值赋值给 nickname 。如果采用 Setter 方法赋值，编译器会提示错误并要求修复。
4.2.利用 Set 的 add 方法
利用 Set 的 add 方法的返回值，可以直接知道该值是否已经存在，可以避免调用 contains 方法判断存在。
普通：
以下案例是进行用户去重转化操作，需要先调用 contains 方法判断存在，后调用add方法进行添加。
Set userIdSet = new HashSet<>();
List userVOList = new ArrayList<>();
for (UserDO userDO : userDOList) {
if (!userIdSet.contains(userDO.getId())) {
userIdSet.add(userDO.getId());
userVOList.add(transUser(userDO));
}
}
精简：
Set userIdSet = new HashSet<>();
List userVOList = new ArrayList<>();
for (UserDO userDO : userDOList) {
if (userIdSet.add(userDO.getId())) {
userVOList.add(transUser(userDO));
}
}
4.3.利用 Map 的 computeIfAbsent 方法
利用 Map 的 computeIfAbsent 方法，可以保证获取到的对象非空，从而避免了不必要的空判断和重新设置值。
普通：
Map> roleUserMap = new HashMap<>();
for (UserDO userDO : userDOList) {
Long roleId = userDO.getRoleId();
List userList = roleUserMap.get(roleId);
if (Objects.isNull(userList)) {
userList = new ArrayList<>();
roleUserMap.put(roleId, userList);
}
userList.add(userDO);
}
精简：
Map> roleUserMap = new HashMap<>();
for (UserDO userDO : userDOList) {
roleUserMap.computeIfAbsent(userDO.getRoleId(), key -> new ArrayList<>())
.add(userDO);
}
4.4.利用链式编程
链式编程，也叫级联式编程，调用对象的函数时返回一个this对象指向对象本身，达到链式效果，可以级联调用。链式编程的优点是：编程性强、可读性强、代码简洁。
普通：
StringBuilder builder = new StringBuilder(96);
builder.append("select id, name from ");
builder.append(T_USER);
builder.append(" where id = ");
builder.append(userId);
builder.append(";");
精简：
StringBuilder builder = new StringBuilder(96);
builder.append("select id, name from ")
.append(T_USER)
.append(" where id = ")
.append(userId)
.append(";");
利用工具方法
5.1.避免空值判断
普通：
if (userList != null && !userList.isEmpty()) { // TODO: 处理代码}
精简：
if (CollectionUtils.isNotEmpty(userList)) { // TODO: 处理代码}
5.2.避免条件判断
普通：
double result;if (value <= MIN_LIMIT) { result = MIN_LIMIT;} else { result = value;}
精简：
double result = Math.max(MIN_LIMIT, value);
5.3.简化赋值语句
普通：
public static final List ANIMAL_LIST;
static {
List animalList = new ArrayList<>();
animalList.add("dog");
animalList.add("cat");
animalList.add("tiger");
ANIMAL_LIST = Collections.unmodifiableList(animalList);
}
精简：
// JDK流派
public static final List ANIMAL_LIST = Arrays.asList("dog", "cat", "tiger");
// Guava流派
public static final List ANIMAL_LIST = ImmutableList.of("dog", "cat", "tiger");
注意：Arrays.asList 返回的 List 并不是 ArrayList ，不支持 add 等变更操作。
5.4.简化数据拷贝
普通：
UserVO userVO = new UserVO();
userVO.setId(userDO.getId());
userVO.setName(userDO.getName());
...
userVO.setDescription(userDO.getDescription());
userVOList.add(userVO);
精简：
UserVO userVO = new UserVO();
BeanUtils.copyProperties(userDO, userVO);
userVOList.add(userVO);
反例：
List<UserVO> userVOList = JSON.parseArray(JSON.toJSONString(userDOList), UserVO.class);
精简代码，但不能以过大的性能损失为代价。例子是浅层拷贝，用不着 JSON 这样重量级的武器。
5.5.简化异常断言
普通：
if (Objects.isNull(userId)) { throw new IllegalArgumentException("用户标识不能为空");}
精简：
Assert.notNull(userId, "用户标识不能为空");
注意：可能有些插件不认同这种判断，导致使用该对象时会有空指针警告。
5.6.简化测试用例
把测试用例数据以 JSON 格式存入文件中，通过 JSON 的 parseObject 和 parseArray 方法解析成对象。虽然执行效率上有所下降，但可以减少大量的赋值语句，从而精简了测试代码。
普通：
@Test
public void testCreateUser() {
UserCreateVO userCreate = new UserCreateVO();
userCreate.setName("Changyi");
userCreate.setTitle("Developer");
userCreate.setCompany("AMAP");
...
Long userId = userService.createUser(OPERATOR, userCreate);
Assert.assertNotNull(userId, "创建用户失败");
精简：
@Test
public void testCreateUser() {
String jsonText = ResourceHelper.getResourceAsString(getClass(), "createUser.json");
UserCreateVO userCreate = JSON.parseObject(jsonText, UserCreateVO.class);
Long userId = userService.createUser(OPERATOR, userCreate);
Assert.assertNotNull(userId, "创建用户失败");
}
建议：JSON 文件名最好以被测试的方法命名，如果有多个版本可以用数字后缀表示。
5.7.简化算法实现
一些常规算法，已有现成的工具方法，我们就没有必要自己实现了。
普通：
int totalSize = valueList.size();
List> partitionList = new ArrayList<>();
for (int i = 0; i < totalSize; i += PARTITION_SIZE) {
partitionList.add(valueList.subList(i, Math.min(i + PARTITION_SIZE, totalSize)));
}
精简：
List<List<Integer>> partitionList = ListUtils.partition(valueList, PARTITION_SIZE);
5.8.封装工具方法
一些特殊算法，没有现成的工具方法，我们就只好自己亲自实现了。
普通：
比如，SQL 设置参数值的方法就比较难用，setLong 方法不能设置参数值为 null 。
// 设置参数值
if (Objects.nonNull(user.getId())) {
statement.setLong(1, user.getId());
} else {
statement.setNull(1, Types.BIGINT);
}
...
精简：
我们可以封装为一个工具类 SqlHelper ，简化设置参数值的代码。
/** SQL辅助类 */
public final class SqlHelper {
/** 设置长整数值 */
public static void setLong(PreparedStatement statement, int index, Long value) throws SQLException {
if (Objects.nonNull(value)) {
statement.setLong(index, value.longValue());
} else {
statement.setNull(index, Types.BIGINT);
}
}
...
}
// 设置参数值
SqlHelper.setLong(statement, 1, user.getId());
最后：
建议默认编写出可读和简单的代码。如果你真的发现存在性能问题并已经找出它的位置，那么仍然有很多选择来对此进行处理而不必为了追求快速而写出复杂的代码。不到万不得已不要为了性能而牺牲简洁性，同时要学会始终用分析工具来处理性能问题。
