MyBatis-Plus-Join 开源项目入门指南

目录结构及介绍

主要模块

• mybatis-plus-join: 主要的框架核心模块。
• mybatis-plus-join-adapter: 适配器模块，处理不同环境下的兼容性问题。
• mybatis-plus-join-annotation: 注解模块，提供了额外的注解功能增强。
• mybatis-plus-join-boot-starter: Spring Boot Starter，方便集成到Spring Boot项目中。
• mybatis-plus-join-core: 核心逻辑模块，包含了主要的功能实现。
• mybatis-plus-join-extension: 扩展模块，提供了更多的高级功能或定制化选项。
• mybatis-plus-join-test: 测试模块，包含各种单元测试和集成测试。

文件结构细节

核心模块 (mybatis-plus-join)

• src/main/java: 包含主要的Java源代码。
  • com.github.yulichang.join: 实现多表关联查询的核心代码。
  • com.github.yulichang.wrapper: 包括MPJLambdaWrapper 和 MPJQueryWrapper等重要封装。
• src/main/resources: 包含配置文件和其他资源如图片、模板等。
  • META-INF/maven/com.github.yulichang/mybatis-plus-join/pom.xml: Maven元数据文件。
  • logback.xml: 日志配置文件。

Spring Boot Starter模块 (mybatis-plus-join-boot-starter)

• src/main/java: 提供与Spring Boot紧密集成的starter类。
  • com.github.yulichang.starter.MybatisPlusJoinAutoConfiguration: 自动配置类，负责自动注册相关组件。
• src/main/resources/META-INF/spring.factories: 配置Spring Bean的发现机制。

启动文件介绍

由于mybatis-plus-join通常作为一个Maven/Gradle依赖加入到项目中，没有独立的“启动文件”。但在Spring Boot项目中，你可以通过下面的MainApplication.java示例了解如何启用它：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import com.github.yulichang.config.JoinConfig;   // 导入配置类

@SpringBootApplication
public class MainApplication {

    public static void main(String[] args) {
        SpringApplication.run(MainApplication.class, args);
        // 启动时的初始化代码可以放在这里
    }
}

这里假设你已经在application.yml或application.properties中正确配置了MyBatis Plus以及mybatis-plus-join相关的设置。

配置文件介绍

在使用mybatis-plus-join时，你需要确保你的应用配置了正确的MyBatis Plus和数据库连接参数。这通常会在Spring Boot的application.yml或application.properties文件中完成。

application.yml 示例

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/test?serverTimezone=UTC
    username: root
    password: your_password
    
  mybatis-plus:
    configuration:
      map-underscore-to-camel-case: true
    type-aliases-package: com.example.entity
    global-config:
      db-config:
        logic-delete-value: 1
        logic-not-delete-value: 0
        id-type: AUTO
    mapper-locations: 
      - classpath:mapper/*.xml

application.properties 示例

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/test?serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=your_password

mybatis-plus.configuration.map-underscore-to-camel-case=true
mybatis-plus.type-aliases-package=com.example.entity
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
mybatis-plus.global-config.db-config.id-type=AUTO
mybatis-plus.mapper-locations=classpath:mapper/*.xml

此外，为了配合mybatis-plus-join的特性，你可能还需要额外的配置来调整其行为，例如开启或关闭某些特定功能，但这些配置具体项取决于你的应用场景需求。在实际应用中，应该参考mybatis-plus-join的最新文档来获取最准确的配置指导。