# xbatis-solon-plugin

**Repository Path**: xbatis/xbatis-solon-plugin

## Basic Information

- **Project Name**: xbatis-solon-plugin
- **Description**: xbatis之 solon 容器 启动插件
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 0
- **Created**: 2024-05-23
- **Last Updated**: 2025-06-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 1.前置说明
> 官方文档：http://xbatis.cn
## 1.1 什么是 xbatis
> xbatis 是一个基于mybatis的轻量级ORM框架；拥有流式丰富的API；设计超前，理念超前，稳定可靠！

> 支持spring,springboot;也支持solon
> 
## 1.2 和mybatis的关系
> xbatis 是基于mybatis扩展的ORM框架，因为mybatis原则上不算是ORM框架；xbatis是补充、扩展！
## 1.3 xbatis的优势
>1. 轻量级封装mybatis,对mybatis的代码改动微乎其微；所以完全兼容mybatis所有功能，包括配置和使用

>2. 基于注解，映射数据库；

>3. 支持多表 join 和返回；

>4. api 采用 lambda 和 stream 流式设计；

>5. select 自动化以及结果 1 对 1,1 对多，超级方便快捷；

>6. 内置分页以及超强的 sql 优化功能；

>7. 稳定且性能极优；

>8. api 丰富，支持数据库函数、多表、乐观锁、多租户、逻辑删除、默认值（可动态值） 等众多功能；

>9. 零学习成本，和写 sql 一样方便。

>10. 支持复杂的返回关系映射：例如一对一 ，一对多，多对多；

>11. 支持自定义 sql 模板，再也不用担心框架支持不足；

>12. 内置代码生成器，通过配置，可定制自身规范；

# 2. 如何在solon中使用
## 2.1 maven 引入
```
<dependency>
    <groupId>cn.xbatis</groupId>
    <artifactId>xbatis-solon-plugin</artifactId>
    <version>1.8.8</version>
</dependency>

<dependency>
    <groupId>org.noear</groupId>
    <artifactId>mybatis-solon-plugin</artifactId>
    <version>3.0.3</version>
</dependency>
```
>xbatis-solon-plugin 是 xbatis针对solon 提供的插件

## 2.2 solon yaml 配置
```yaml
# 配置数据源
ds:
  # 与数据库名可用保持一致
  schema: rock
  jdbcUrl: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&autoReconnect=true&rewriteBatchedStatements=true
  driverClassName: com.mysql.cj.jdbc.Driver
  username: root
  password: 123456

# 规则 mybatis.数据源名称;数据源名称 是 数据源 Bean的名称
mybatis.master:
  mappers:       #支持包名 或 类名（大写开头 或 *）或 xml（.xml结尾）；支持目录 ** 或 * 占位符
    - "test.UserMapper"
    - "demo4021.**.mapper"
    - "demo4021.**.mapper.*" #这个表达式同上效果
    - "classpath:demo4021/**/mapper.xml"
    - "classpath:demo4021/**/mapping/*.xml"   

```
## 2.3 DataSource Bean配置
```java
@Configuration
public class MybatisConfig {

    @Bean(name = "master", typed = true)
    public DataSource dataSource(@Inject("${ds}") HikariDataSource ds) {
        return ds;
    }


//    @Bean(name = "db1", typed = true)
//    public DataSource db1(@Inject("${ds.db1}") HikariDataSource ds) {
//        return ds;
//    }
//
//    @Bean(name = "db2", typed = true)
//    public DataSource db2(@Inject("${ds.db1}") HikariDataSource ds) {
//        return ds;
//    }
}
```
## 2.4 在业务中使用

```java
import org.noear.solon.annotation.Get;

// Mapper 需要继承 MybatisMapper
public interface UserMapper extends MybatisMapper<User> {
}

// 在 Controller 中使用 （这是示例，不建议在Controller 里使用）
@Controller
public class DemoController {

    @Db  //因为只有一个数据源 所以可简写；如果多个，则：@Db("master")
    UserMapper mapper;
    
    @Get
    @Mapping("/test")
    public void test() {
        List<User> userList = QueryChain.of(mapper)
                .eq(User::getId)
                .like(User::getName,"abc")
                .list();
        userList.forEach(item -> System.out.println(item.getName()));
    }
}
```

# 3.更多使用xbatis的使用说明
请前往xbatis 查看：https://gitee.com/xbatis

# 4.更多配置说明
配置和 solon mybatis-solon-plugin 配置是一样的：https://solon.noear.org/article/20