常用编程技巧和代码规范总结#

1@Getter
2@AllArgsConstructor
3public enum NameType {
4    /**
5     * 名称
6     */
7    FACTORY_NAME("name");
8    
9    /**
10     * 值
11     */
12    private final String value;
13}

1// 代码示例
2public void readFile() throws FileNotFoundException {
3    try (FileReader fr = new FileReader("d:/input.txt");BufferedReader br = new BufferedReader(fr)) {
4        String s = "";
5        while ((s = br.readLine()) != null) {
6            System.out.println(s);
7        }
8    } catch (IOException e) {
9        e.printStackTrace();
10    }
11}

1public static void writeWallpaper(List<WallpaperData> wallpaperDataList) throws IOException {
2    if (!Files.exists(WALLPAPER_PATH)) {
3        Files.createFile(WALLPAPER_PATH);
4    }
5    // 扫描本地文件
6    List<WallpaperData> data = readWallpaperData();
7    if (CollUtil.isNotEmpty(data)) {
8        wallpaperDataList.addAll(data);
9    }
10    // 排序
11    List<WallpaperData> collect = wallpaperDataList.stream()
12            // 倒序,最新日期排前面
13            .sorted(Comparator.comparing(WallpaperData::getCreatedAt).reversed())
14            .collect(Collectors.toList());
15    Files.write(WALLPAPER_PATH, "## Wallpaper".getBytes());
16    Files.write(WALLPAPER_PATH, System.lineSeparator().getBytes(), StandardOpenOption.APPEND);
17    collect.forEach(wallpaperData -> {
18        try {
19            Files.write(WALLPAPER_PATH, wallpaperData.formatMarkdown().getBytes(), StandardOpenOption.APPEND);
20            Files.write(WALLPAPER_PATH, System.lineSeparator().getBytes(), StandardOpenOption.APPEND);
21            Files.write(WALLPAPER_PATH, System.lineSeparator().getBytes(), StandardOpenOption.APPEND);
22        } catch (IOException e) {
23            log.error(e.getMessage(), "Failed to write wallpaper.md file");
24        }
25    });
26}

1@PostMapping("/insertMarketIndex")
2public AbstractTip<Integer> insertMarketIndex(@Validated MarketIndexDTO dto) {
3    if (ObjectUtils.isEmpty(dto)) {
4        return new ErrorTip<>("The data is null , abnormal, burst out NullPointerException");
5    }
6    return new SuccessTip<>(marketIndexService.insertMarketIndex(MarketIndexConverter.INSTANCE.toDto(dto)));
7}

1/**
2 * 判断规范示例
3 * 
4 * 1. 布尔表达式命名规范
5 *    - 命名应当清晰、具有描述性
6 *    - 避免使用单个字母或缩写，除非是广泛接受的约定（例如，使用 "isEnabled()" 而不是 "isE()"）
7 *    - 使用驼峰命名法
8 *
9 * 2. 判断语句格式规范
10 *    - 使用大括号{}括起来判断体，即使只有一条语句
11 *    - 使用缩进使代码块更易读
12 *
13 * 3. 避免冗余的判断
14 *    - 不要使用多余的嵌套判断，保持代码的简洁性
15 *    - 考虑使用逻辑运算符（&&、||）来合并条件
16 *
17 * 4. 注意空指针判断
18 *    - 在可能出现空指针的地方进行判断，避免空指针异常
19 *    - 使用 Objects.requireNonNull 或 Optional 类来处理可能的空值
20 *
21 * 5. 使用 equals 方法进行对象比较
22 *    - 避免使用 "==" 运算符进行对象比较，应当使用 equals 方法
23 *    - 如果需要比较基本数据类型，可以使用 "==" 运算符
24 *
25 * 6. 使用 switch 语句的时候注意 break
26 *    - 在 switch 语句中，每个 case 语句结束后都要添加 break，防止穿透到下一个 case
27 *
28 * 7. 注释规范
29 *    - 在复杂的判断逻辑处添加注释，解释判断的目的和可能的结果
30 *    - 注释要保持更新，确保它们反映代码的实际状态
31 *
32 * 8. 单元测试
33 *    - 编写相应的单元测试来验证判断的正确性
34 *    - 考虑使用断言来验证判断的期望结果
35 *
36 * 9. 集合判断规范
37 *    - 在判断集合是否为空时，使用集合类的 isEmpty() 方法
38 *    - 避免使用 size() 方法判断集合是否为空，因为它可能引起不必要的遍历
39 *    - 示例：if (list.isEmpty()) { /* 集合为空的处理 */ }
40 */

1import java.util.List;
2
3/**
4 * 判断规范示例（包含集合判断）
5 * 
6 * <p>
7 * 该类演示了在Java中编写判断语句的规范。其中包含布尔表达式的命名规范、判断语句的格式规范、避免冗余的判断、
8 * 注意空指针判断、使用 equals 方法进行对象比较、使用 switch 语句的时候注意 break、注释规范、单元测试等内容。
9 * </p>
10 * 
11 * <p>
12 * 集合判断规范：
13 * 在判断集合是否为空时，使用集合类的 isEmpty() 方法。避免使用 size() 方法判断集合是否为空，因为它可能引起不必要的遍历。
14 * </p>
15 * 
16 * <pre>
17 * 示例代码：
18 * {@code
19 * List<String> stringList = List.of("one", "two", "three");
20 * if (isListEmpty(stringList)) {
21 *     System.out.println("List为空");
22 * } else {
23 *     System.out.println("List不为空");
24 * }
25 * }
26 * </pre>
27 * 
28 * <p>
29 * 使用该类时，请注意替换示例中的具体逻辑和集合类型以适应你的实际项目需求。
30 * </p>
31 * 
32 * @version 1.0
33 * @since 2024-01-29
34 */
35public class JudgmentSpecificationWithCollectionsExample {
36
37    /**
38     * 判断List是否为空的示例方法
39     *
40     * @param list 待判断的List
41     * @return 如果List为空，则返回 true；否则返回 false
42     */
43    private static boolean isListEmpty(List<?> list) {
44        // 示例判断逻辑
45        return list == null || list.isEmpty();
46    }
47
48    /**
49     * 主方法，包含示例代码的执行
50     * 
51     * @param args 命令行参数
52     */
53    public static void main(String[] args) {
54        // 示例代码
55        List<String> stringList = List.of("one", "two", "three");
56
57        if (isListEmpty(stringList)) {
58            System.out.println("List为空");
59        } else {
60            System.out.println("List不为空");
61        }
62    }
63}