JPlusOne 项目使用教程

JPlusOne 项目使用教程

jplusone Tool for automatic detection and asserting "N+1 SELECT problem" occurences in JPA based Spring Boot Java applications and finding origin of JPA issued SQL statements in general 项目地址: https://gitcode.com/gh_mirrors/jp/jplusone

1. 项目的目录结构及介绍

JPlusOne 项目的目录结构如下：

jplusone/
├── cmd
│   ├── mvnw
│   └── mvnw.cmd
├── pom.xml
├── release-ci.sh
├── release.sh
├── README.md
├── LICENSE
└── src/
    ├── main/
    │   └── java/
    │       └── com/
    │           └── adgadev/
    │               └── jplusone/
    │                   ├── core/
    │                   ├── properties/
    │                   └── test/
    │                       └── domain/
    │                           └── bookshop/
    └── test/
        └── java/
            └── com/
                └── adgadev/
                    └── jplusone/
                        └── test/
                            └── domain/
                                └── bookshop/

目录结构介绍

• cmd/: 包含 Maven Wrapper 文件，用于在不同操作系统上运行 Maven 命令。
• pom.xml: Maven 项目的配置文件，定义了项目的依赖和构建配置。
• release-ci.sh 和 release.sh: 用于项目发布的脚本文件。
• README.md: 项目的介绍文档，包含项目的基本信息和使用说明。
• LICENSE: 项目的开源许可证文件。
• src/: 项目的源代码目录。
  • main/java/: 包含项目的主要 Java 源代码。
  • test/java/: 包含项目的测试代码。

2. 项目的启动文件介绍

JPlusOne 项目的主要启动文件是 pom.xml，它定义了项目的依赖和构建配置。通过 Maven Wrapper 文件 mvnw 或 mvnw.cmd，可以在不同操作系统上运行 Maven 命令来启动项目。

启动步骤

1. 安装 Maven Wrapper:

   • 在项目根目录下运行以下命令：

     ./mvnw install
     

2. 运行项目:

   • 使用 Maven Wrapper 启动项目：

     ./mvnw spring-boot:run
     

3. 项目的配置文件介绍

JPlusOne 项目的主要配置文件是 application.yml，它位于 src/main/resources/ 目录下。该文件用于配置 JPlusOne 的行为和日志输出。

配置文件示例

jplusone:
  enabled: true
  application-root-package: "com.sampleorganisation.sampleproject"
  debug-mode: false
  report:
    enabled: true
    output: LOGGER
    proxy-call-frames-hidden: true
    operation-filtering-mode: ALL_OPERATIONS
    statement-filtering-mode: ALL_STATEMENTS
    file-path: target/jplusone-report.txt

配置项说明

• jplusone.enabled: 是否启用 JPlusOne 自动配置，默认值为 true。
• jplusone.application-root-package: 项目的根包名，默认值为 @SpringBootApplication 注解所在类的包名。
• jplusone.debug-mode: 是否启用调试模式，默认值为 false。
• jplusone.report.enabled: 是否启用报告输出，默认值为 true。
• jplusone.report.output: 报告输出方式，可以是 LOGGER 或 FILE。
• jplusone.report.proxy-call-frames-hidden: 是否隐藏代理调用帧，默认值为 true。
• jplusone.report.operation-filtering-mode: 报告中的操作过滤模式，默认值为 ALL_OPERATIONS。
• jplusone.report.statement-filtering-mode: 报告中的 SQL 语句过滤模式，默认值为 ALL_STATEMENTS。
• jplusone.report.file-path: 报告文件的输出路径，默认值为 target/jplusone-report.txt。

通过以上配置，可以灵活地调整 JPlusOne 的行为，以满足不同的需求。

jplusone Tool for automatic detection and asserting "N+1 SELECT problem" occurences in JPA based Spring Boot Java applications and finding origin of JPA issued SQL statements in general 项目地址: https://gitcode.com/gh_mirrors/jp/jplusone