SpringBoot Mybatis 組態檔形式詳解

2023-03-23 22:04:41

1. 概述

在之前BiliBili學習SprintBoot時候，按照視訊敲程式碼，SpringBoot整合MyBatis，是單獨寫了一個mybatis-config.xml檔案。設定資料連線以及mapper等資訊。後來問了下從事Java得同事，告知mybatis-config.xml檔案其實可以寫到application.yml。當時也沒弄清楚。後來摸索中，也就漸漸明白了。

2. 單獨設定mybatis-config.xml

2.1 設定內容

當時視訊學習，也寫下學習得總結。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<!--configuration核心組態檔-->
<!--順序 properties->settings->typeAliases->typeHandlers->objectFactory->objectWrapperFactory->reflectorFactory->plugins->environments->databaseIdProvider->mappers-->
<configuration>
    <!--jdbc.properties組態檔-->
    <properties resource="jdbc.properties"></properties>
 
    <!--設定mybatis輸出紀錄檔 Mybatis預設就是STDOUT_LOGGING-->
    <settings>
        <setting name="logImpl" value="STDOUT_LOGGING"/>
    </settings>
 
    <!--  型別別名 預設為類名 指定這個後 mapper的xml檔案指定返回值時候 可直接寫類名(不區分大小寫) 建議直接拷貝類名  -->
    <typeAliases>
        <package name="com.ceaning.crudp.entity"/>
    </typeAliases>
 
    <!-- 環境設定 -->
    <!-- development IDEA預設 開發環境 -->
    <!-- 可以自定義 比如定義test formal 看心情 每個SqlSessionFactory範例只能選擇一種環境 這個可隨時設定 -->
    <!-- test 測試環境 -->
    <!-- formal 正式環境 -->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>
    <!-- 對映器 每一個mapper.xml都需要在Mybatis的核心檔案中註冊! -->
    <!-- 註冊方式1 使用xml檔案 <mapper resource="com/ceaning/efmis/mapper/UserMapper.xml"/> -->
    <!-- 註冊方式2 使用class檔案 <mapper class="com.ceaning.efmis.mapper.UserMapper"/> -->
    <!-- 註冊方式3 mapper代理方式 <package name="com.ceaning.efmis.mapper"/> -->
    <!--
        註冊方式2(使用class檔案)和註冊方式3(使用包掃描註冊)
        1.介面和他的Mapper組態檔必須同名
        2.介面和他的Mapper組態檔必須在同一個包下
    -->
    <mappers>
        <package name="com.ceaning.crudp.mapper"/>
    </mappers>
</configuration>

jdbc.properties內容如下:

單獨寫jdbc得設定，是擔心以後要是部署成WAR形式，修改mybatis-config.xml內容得話，內容太多，防止修改錯，就單獨搞個jdbc設定。(其實我想多了)

driver=com.microsoft.sqlserver.jdbc.SQLServerDriver
url=jdbc:sqlserver://127.0.0.1:1433;databaseName=EFMIS
username=sa
password=123qwe,.

2.2 輔助類

輔助類得作用在於初始呼叫類得時候，實現設定載入，並建立SqlSessionFactory，方便後面進行SQL查詢。

public class MybatisUtils {
    //SqlSessionFactory 靜態單例模式
    private static SqlSessionFactory sqlSessionFactory;
 
    //使用Mybatis第一步 獲取SqlSessionFactory物件
    static {
        try{
            String resource="mybatis-config.xml";
            InputStream inputStream= Resources.getResourceAsStream(resource);
            sqlSessionFactory= new SqlSessionFactoryBuilder().build(inputStream);
        } catch (Exception e){
            e.printStackTrace();
        }
    }
 
    //獲取SqlSession範例
    //該範例包含了面向資料庫執行sql命令所需要的所有方法
    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }
}

2.3 呼叫操作

此處我以登入操作為例。這樣就可以連線資料庫進行操作。

@PostMapping("/user/login")
    public Result<?> login(@RequestBody User user){
        SqlSession sqlSession= null;
        Map<String, Object> map= new HashMap<>();
        try{
            sqlSession= MybatisUtils.getSqlSession();
            UserMapper mapper= sqlSession.getMapper(UserMapper.class);
            user= mapper.login(user);
            if (user!= null){
                //生成token
                Map<String, String> tokenmap= new HashMap<>();
                tokenmap.put("loginname", user.getLoginname());
                tokenmap.put("password", user.getPassword());
                String token= JwtUtils.getToken(tokenmap);
                //返回資料
                map.put("user", user);
                map.put("token", token);
                return Result.ok(map);
            } else {
                return Result.error(CommonConstant.SYS_ERR_CODE, "使用者不存在!");
            }
        } catch (Exception e){
            e.printStackTrace();
            return Result.error("異常!"+ e.getMessage());
        } finally {
            if (sqlSession!= null){
                sqlSession.close();
            }
        }
    }

3. application.yml設定mybatis

3.1 設定內容

多餘得內容不用管它。主要是設定資料來源spring.datasource。設定資料庫連線資訊。

 
Server:
  port: 8090
 
spring:
  # quartz定時任務設定
  quartz:
    # 資料庫儲存方式
    job-store-type: jdbc
    org:
      quartz:
        jobStore:
          class: org.springframework.scheduling.quartz.LocalDataSourceJobStore
  #設定資料來源
  datasource:
    url: jdbc:sqlserver://127.0.0.1:1433;SelectMethod=cursor;databaseName=EFMIS
    username: sa
    password: 123qwe,.
    driver-class-name: com.microsoft.sqlserver.jdbc.SQLServerDriver
  #json
  jackson:
    date-format: yyyy-MM-dd HH:mm:ss
    time-zone: GMT+8
  #熱部署
  devtools:
    restart:
      enabled: true
      additional-paths: src/main/java
      exclude: static/**
  jta:
    atomikos:
      properties:
        recovery:
          forget-orphaned-log-entries-delay:
mybatis:
  configuration:
    #開啟駝峰對映
    map-underscore-to-camel-case: true
    #開啟快取
    cache-enabled: true
  #載入mapper.xml檔案
  mapper-locations: classpath:com/ceaning/crudp/mapper/*.xml
  #別名掃描
  type-aliases-package: com.ceaning.crudp.entity
logging:
  config: classpath:logback-spring.xml

3.2 輔助類

@Component
public class SpringUtils implements BeanFactoryPostProcessor {
    /**
     * Spring應用上下文環境
     */
    private static ConfigurableListableBeanFactory beanFactory;
 
 
    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException {
        SpringUtils.beanFactory= configurableListableBeanFactory;
    }
 
    public static <T> T getBean(String name) throws BeansException{
        name= lowerCaseInit(name);
        if(containsBean(name)){
            return (T) beanFactory.getBean(name);
        } else{
            return null;
        }
    }
 
    /**
     * 獲取
     * @param cls
     * @return
     * @param <T>
     * @throws BeansException
     */
    public static <T> T getBean(Class<T> cls) throws BeansException{
        T result= (T) beanFactory.getBean(cls);
        return result;
    }
 
    /**
     * 判斷 BeanFactory是否包含bean物件
     * @param name
     * @return
     */
    public static boolean containsBean(String name){
        return beanFactory.containsBean(name);
    }
 
    /**
     * 判斷以給定名字註冊的bean定義是一個singleton還是一個prototype。
     * 如果與給定名字相應的bean定義沒有被找到，將會丟擲一個異常（NoSuchBeanDefinitionException）
     * @param name
     * @return
     * @throws NoSuchBeanDefinitionException
     */
    public static boolean isSingleton(String name) throws NoSuchBeanDefinitionException{
        return beanFactory.isSingleton(name);
    }
 
    public static Class<?> getType(String name) throws NoSuchBeanDefinitionException{
        return beanFactory.getType(name);
    }
 
    public static String[] getAliases(String name) throws NoSuchBeanDefinitionException{
        return beanFactory.getAliases(name);
    }
 
    /**
     * 首字母小寫
     * @param name
     * @return
     */
    private static String lowerCaseInit(String name){
        if(name.length()>0){
            char c= name.charAt(0);
            if(c>=65 && c<=90){
                int i= c+ 32;
                return ((char)i)+ name.substring(1);
            } else{
                return name;
            }
        } else{
            return null;
        }
    }
}

3.3 呼叫操作

此處還是以登入操作為例。同樣可以進行資料庫連線操作。

@PostMapping("/user/login")
    public Result<?> login(@RequestBody User user){
        Map<String, Object> map= new HashMap<>();
        try{
            UserMapper mapper= SpringUtils.getBean(UserMapper.class);
            user= mapper.login(user);
            if (user!= null){
                //生成token
                Map<String, String> tokenmap= new HashMap<>();
                tokenmap.put("loginname", user.getLoginname());
                tokenmap.put("password", user.getPassword());
                String token= JwtUtils.getToken(tokenmap);
                //返回資料
                map.put("user", user);
                map.put("token", token);
                return Result.ok(map);
            } else {
                return Result.error(CommonConstant.SYS_ERR_CODE, "使用者不存在!");
            }
        } catch (Exception e){
            e.printStackTrace();
            return Result.error("異常!"+ e.getMessage());
        } 
    }