# mapper_refresh

**Repository Path**: qiaomulzy_admin_admin/mapper-refresh

## Basic Information

- **Project Name**: mapper_refresh
- **Description**: mybatis mapper自动刷新
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-02-25
- **Last Updated**: 2022-02-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mybatis mapper xml热刷新功能

<a name="4oVQk"></a>
## 使用
**idea为例，在修改mapper之后，ctrl+shift+F9编译xml，等待刷新任务执行后即可生效**<br />![image.png](https://cdn.nlark.com/yuque/0/2020/png/1609104/1607248343391-417e8634-516b-4c63-b2c9-c34ca39d892b.png#align=left&display=inline&height=410&margin=%5Bobject%20Object%5D&name=image.png&originHeight=560&originWidth=761&size=44768&status=done&style=none&width=557)<br />

<a name="rLgJp"></a>
## 接入
<a name="iyI4h"></a>
### mapper-core
自动刷新插件的基础包，核心逻辑都在这里实现，只依赖mybatis，可脱离spring运行。<br />非spring接入示例
```java
public static void main(String[] args) {
        CoreServiceChain<MapperRefreshContext> chain = new CoreServiceChain();
        chain.setServiceProcessList(Arrays.asList(new RefreshResourceProcess()));
        File[] yourMapperFiles = new File[]{new File("you mapper file path ...")};
        MyMapperRefresh myMapperRefresh = new MyMapperRefresh(
                sqlSessionFactory,yourMapperFiles,chain,true
        );
        myMapperRefresh.run();
}
```
<a name="zn8zN"></a>
### mapper-spring
这是spring接入的包，接入示例
```xml
<bean id="mapperRefreshFactoryBean" class="com.ccod.mapper.spring.MapperRefreshFactoryBean">
        <!--延迟启动时间，单位秒，不小于10秒-->
        <property name="delaySeconds" value="10"></property>
        <!--刷新间隔，单位秒，不小于10秒-->
        <property name="sleepSeconds" value="20"></property>
        <!--扫描mapper xml路径，配置同mybatis方式，多个逗号隔开-->
        <property name="mapperLocations" value="classpath*:mapper/**/*Mapper.xml"></property>
        <!--开启自动刷新功能-->
        <property name="enabledRefresh" value="true"></property>
        <!--mybatis 的 sqlSessionFactory-->
        <property name="sqlSessionFactory" ref="sqlSessionFactory"></property>
        <!--执行链，默认这个就可以，可以继续扩展-->
        <property name="serviceProcessList">
            <list>
                <bean class="com.ccod.mapper.mapper.core.chain.process.RefreshResourceProcess"></bean>
            </list>
        </property>
    </bean>
```
<a name="wN0Db"></a>
### mapper-refresh-boot-start(推荐)
springboot start接入
<a name="enntV"></a>
#### 可选配置（prefix = "mapper-refresh"）
| key | value | 注释 |
| --- | --- | --- |
| enabledRefresh | true/false | 是否开启自动刷新功能 |
| mapperLocations | classpath*:mapper/**/*Mapper.xml | 配置同mybatis，<br />若不配，<br />优先取<br />mybatis.mapper-locations,<br />其次取<br />mybatis-plus.mapper-locations|
| delaySeconds | 10 | 延迟启动时间，单位秒，不小于10秒 |
| sleepSeconds | 20 | 刷新间隔，单位秒，不小于10秒 |



<a name="5mdor"></a>
### 新增自定义的执行链(无特殊需求无需配置)
```java
	@Bean
    public List<CoreServiceProcess> serviceProcesses(){
        List<CoreServiceProcess> serviceProcesses = Lists.newArrayList();
        serviceProcesses.add();
        ...
        return serviceProcesses;
    }
```

<br />理论上在application.yml如下配置便可在你的项目中运行
```java
mapper-refresh:
  enabled-refresh: true
```