深入解读oblac/jodd项目的代码风格与测试规范-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00570/article/details/148549549

深入解读oblac/jodd项目的代码风格与测试规范

jodd Jodd! Lightweight. Java. Zero dependencies. Use what you like. 项目地址: https://gitcode.com/gh_mirrors/jo/jodd

前言

在软件开发中，统一的代码风格和规范的测试实践对于项目的可维护性和团队协作至关重要。本文将详细解析oblac/jodd项目所采用的编码规范、命名约定以及测试方法，帮助开发者更好地理解和使用这一框架。

代码风格规范

基础格式要求

项目采用**制表符(TAB)**而非空格进行缩进，这种选择虽然与某些主流规范不同，但体现了团队对统一性的重视。开发者需要注意，在贡献代码时必须严格遵守这一约定。

接口设计原则

接口中可以包含静态工厂方法，用于创建已知实现类的实例。这种设计模式提供了灵活的实例化方式：

Value.of(123);      // 创建值对象
List.arrayList();   // 创建新的数组列表
Component.get();    // 返回默认的单例实现

空值处理哲学

项目遵循"常识原则"，不添加多余的null检查代码。只有当确实需要时才使用Objects.requireNonNull()进行验证。如果代码本身会抛出NullPointerException，则无需额外检查。

工具类设计

工具类(*Util)不强制要求私有构造函数，这体现了项目对"常识原则"的坚持。开发者应当自行判断是否需要防止工具类被实例化。

方法命名规范

只有真正的Java Bean才使用getFoo()和setFoo()形式的访问器方法
工具类中创建新实例的静态方法应命名为：
- create()或createFooBar()（无参数时）
- fooBarOf(argument)（有参数时）
构建器模式中：
- 构建方法应命名为create()
- 最终构建方法应命名为get()或buildFoo()

特殊模式实现

对于流畅接口API的抽象基类，推荐使用_this()方法：

@SuppressWarnings("unchecked")
protected T _this() {
    return (T) this;
}

方法参数应声明为final，这有助于提高代码的可读性和安全性。

设计模式实现规范

单例模式

项目尽量避免使用单例模式。当确实需要时，单例实例通过静态get()方法获取：

public class MyFoo {
    private static final MyFoo MY_FOO = new MyFoo();

    public static MyFoo get() {
        return MY_FOO;
    }
}

默认实现机制

接口的默认实现存储在名为Implementation的静态内部类中。修改实现使用set()方法：

public static interface MyFoo {
    class Implementation {
        private static MyFoo myFoo = new DefaultMyFoo();
        public static void set(MyFoo myFoo) {
            this.myFoo = myFoo;
        }
    }

    public static MyFoo get() {
        return Implementation.myFoo;
    }
}

默认配置

对于用户直接创建的类(如JsonParser或HttpRequest)，可以通过Defaults内部类提供默认配置：

public class MyFoo {
    public static class Defaults {
        public static boolean someFlag = false;
    }
}

注意：单例类不应使用默认配置机制。

测试规范

命名约定

测试类以*Test结尾，如StringUtilTest
测试方法以test*开头，如testReplace()
测试方法和类使用包作用域(非public)

组织结构

可以安全使用JUnit 5的实验性功能，但需要持续维护
嵌套测试类不需要添加特殊后缀
推荐静态导入Assert和Assume方法
每个测试方法应专注于测试一个特定功能

测试示例

class FooTest {

    @Test
    void testSomething() {
      // 测试代码
    }

    @Nested
    @DisplayName("测试特定功能集")
    class FeatureSet {

        @Test
        void testFeature_with_null() {
          // 测试代码
        }

        @Test
        void testFeature_with_something_else() {
          // 测试代码
        }
    }
}