Deptective：编译时的Java包依赖检查工具-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00074/article/details/141745944

Deptective：编译时的Java包依赖检查工具

deptectiveA plug-in for the Java compiler that validates a project's package relationships项目地址:https://gitcode.com/gh_mirrors/de/deptective

项目介绍

Deptective是一款专为Java编译器(javac)设计的插件，旨在验证项目内部包之间的依赖关系是否符合预设的允许依赖规则。该工具强调软件系统的清晰结构，通过定义组件间的正确包访问关系，并在编译阶段强制执行这些规则，从而帮助开发者早期发现并修正不适当的依赖问题。相比传统的架构监控工具，其直接集成于编译流程中，提供即时反馈，适用于希望维持高质量代码库的团队。

项目快速启动

要快速启动使用Deptective，您需要先确保开发环境满足以下条件：至少安装了JDK 8以及Maven。以下是将Deptective应用于一个已有或新项目的步骤：

添加Jitpack仓库到您的pom.xml:

<repositories>
  <repository>
    <id>jitpack</id>
    <url>https://jitpack.io</url>
  </repository>
</repositories>

引入Deptective插件:

在pom.xml的<build>部分添加插件配置，示例如下：

<build>
  <plugins>
    <plugin>
      <groupId>com.github.moditect</groupId>
      <artifactId>deptective-javac-plugin</artifactId>
      <version>master-SNAPSHOT</version>
      <executions>
        <execution>
          <goals>
            <goal>check</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

定义依赖规则:

创建一个deptective.json文件来描述您的包依赖规则。例如，规定服务层可以访问数据持久层但反之不行。
构建项目以检查依赖关系:

使用Maven进行构建，Deptective将在编译过程中检查依赖关系是否合规。
```
mvn clean compile
```

如果存在未经许可的依赖，编译将会失败，并提示具体的问题位置。

应用案例和最佳实践

Spring PetClinic修改案例：作为应用案例，可以在Spring PetClinic样例应用中实施Deptective，防止模型包直接依赖访问如“visit”包等非预期依赖，确保代码结构清晰。
最佳实践：定期审查deptective.json，确保它随着项目的发展而更新，维持严格的分层逻辑，避免循环依赖，提升代码可维护性。