二、springBoot 整合 mybatis 項目實戰

前言

上一篇文章開始了我們的springboot序篇，我們配置了mysql數據庫，但是我們sql語句直接寫在controller中並且使用的是jdbcTemplate。項目中肯定不會這樣使用，上篇文章也說了，會結合mybatis 或者JPA 使用。我們這篇文章就來結合 mybatis 來使用吧，至於爲什麼選mybatis 而不是JPA ，這個看個人洗好吧。然後這篇文章會附帶一講一下今天爲項目新增的配置。主要是爲了保持項目和文章的一致性。

先貼出我們今天項目的結構吧，和昨天貼出來的差不多，在那基礎上添加了一些東西，整個框架的模型算是成型了。

引入mybatis依賴

一般改動都是從pom.xml 開始的，我們在昨天基礎上的pom.xml 文件中加上mybatis 依賴,版本自己選吧。

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.0.0</version>
 </dependency>

Entry層

昨天我們創建了一個user表 並插入了一條數據，我們就先用這張表吧，所以我們在entry 包中創建一個UserEntry 的實體類.
代碼如下：

@Getter
@Setter
public class UserEntry {
    private int id;
    private String userName;
    private String password;
    private String email;
    private String roleCode;
    private String roleName;
    private String gmtCreate;
    private String gmtUpdate;
    private String nickname;
    private String userCreate;
}

可以看到這裏用的註解和@Getter 和@Setter。這裏就是避免代碼中寫入過多的get和 set 方法，使得代碼變得更加簡潔。

Dao 層

Dao是用來處理數據的，這裏我們引入了mybatis ,可以使用註解，也可以創建xml 文件，將sql 語句寫在xml 文件中。我們這裏就採用註解的方式吧，畢竟我們springboot項目，不想再出現xml配置文件了(後期也說不定哈哈)。

在dao包下創建一個userMapper 接口。代碼如下：

@Mapper
public interface UserMapper {

    @Select("select id,username as userName,password,email,role_code as roleCode,gmt_create as gmtCreate,gmt_update as gmtUpdate,nickname as nickName,user_create as userCreate from sys_user")
    List<UserEntry> findUserList();

    @Insert({"insert into sys_user(username,password,email) values('${user.userName}','${user.password}','${user.email}')"})
    int add(@Param("user") UserEntry user);

    @Delete("delete from sys_user where id = #{id}")
    int delete(int id);

}

我們這裏就先寫一個查詢、刪除和插入的方法吧。可以看到，在接口上引入@Mapper 註解，然後就可以直接使用@Select 和@Insert 等註解啦，直接把註解sql 語句寫在這裏面就可以了。

Service 層

service層我們一般都以一個接口和一個實現接口的具體類。

service 接口

代碼如下：

public interface UserService {

    List<UserEntry> findUserList();

    int addUser(String userName,String password,String email);

    int deleteUser(int id);
}

serviceImpl 具體實現類。

在service 包的impl 包創建 UserServiceImpl 類。代碼如下：

@Service
public class UserServiceImpl implements UserService {


    @Autowired
    protected UserMapper userMapper;

    @Override
    public List<UserEntry> findUserList() {
        return userMapper.findUserList();
    }

    @Override
    public int addUser(String userName, String password, String email) {
        UserEntry user=new UserEntry();
        user.setUserName(userName);
        user.setPassword(password);
        user.setEmail(email);
        return userMapper.add(user);
    }

    @Override
    public int deleteUser(int id) {
        return userMapper.delete(id);
    }
}

controller 層

我們在controller 包下的userinfo 包下創建UserController 類。代碼如下：

@Slf4j
@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @RequestMapping(value = "/list",method = RequestMethod.GET)
    public List<UserEntry> findUserList(){
        return userService.findUserList();
    }

    @RequestMapping(value = "/add",method = RequestMethod.GET)
    public String addUser(@RequestParam(value = "userName")String uaserName,@RequestParam(value = "password")String password,@RequestParam(value = "email")String email){
        int falg=userService.addUser(uaserName,password,email);
        if(falg>0){
            return "success";
        }
        return "error";
    }

    @RequestMapping(value = "/delete",method = RequestMethod.GET)
    public String deleteUser(@RequestParam(value = "id")int id){
        if(userService.deleteUser(id)>0){
            return "success";
        }
        return "error";
    }
}

測試

好了，萬事具備，來測試吧。我們啓動項目後，在瀏覽器輸入

添加一個用戶
http://localhost:9090/zlflovemm/user/add?userName=qaz&password=123456&[email protected]

查詢所有用戶
http://localhost:9090/zlflovemm/user/list

刪除一個用戶
http://localhost:9090/zlflovemm/user/delete?id=19

都沒有問題啦，說明基本的增刪改查整合 mybatis 都是可行的。

配置多環境文件

好了，大頭講完了，我們現在來講講項目今天進行了哪些配置。首先我們來看下我們項目中多了好幾個配置文件。

分別對應的是開發環境，測試環境，生產環境。畢竟我們在實際開發過程中，這三個環境都是經常有用到的，總會有數據庫連接改來改去的問題。這裏直接配置多份，想用哪個用那個就可以了。避免反覆改容易出錯的問題。
我這裏就暫時把連接mysql 的鏈接放到不同環境了。
先在application.properties中加入

spring.profiles.active=dev
表示用的是開發環境，就會讀取application-dev.yml 文件中的配置。

application-dev.xml文件內容如下，另外兩個文件也差不多，就不貼出來了。

配置日誌

項目中怎麼能缺乏日誌文件呢，我這裏用的springboot 自帶的日誌框架logback 也很方便。我們先在application.properties 中加入

#日誌配置
logging.level.org.springframework.web=info
logging.config=classpath:logback.xml
debug=true

然後在 application.properties 同目錄下創建一個 logback.xml.內容如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">

    <!--定義日誌文件的存儲地址 勿在 LogBack 的配置中使用相對路徑-->
    <property name="LOG_HOME" value="./logs" />
    <property name="INFO_FILE" value="zlflovemm_log" />
    <property name="ERROR_FILE" value="zlflovemm_error" />

    <!--控制檯日誌， 控制檯輸出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度,%msg：日誌消息，%n是換行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 文件保存日誌的相關配置，同步 -->
    <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <Prudent>true</Prudent>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日誌文件輸出的文件名-->
            <FileNamePattern>
                ${LOG_HOME}/${INFO_FILE}-%d{yyyy-MM-dd}.log
            </FileNamePattern>
            <!--日誌文件保留天數-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日誌消息，%n是換行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}[%t][%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <!--日誌文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <!-- 文件保存日誌的相關配置，同步 -->
    <appender name="ERROR"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
        <Prudent>true</Prudent>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日誌文件輸出的文件名-->
            <FileNamePattern>
                ${LOG_HOME}/${ERROR_FILE}-%d{yyyy-MM-dd}.log
            </FileNamePattern>
            <!--日誌文件保留天數-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級別從左顯示5個字符寬度%msg：日誌消息，%n是換行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}[%t][%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <!--日誌文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <!-- 日誌輸出級別 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE"/>
        <appender-ref ref="ERROR" level="error" />
    </root>
</configuration>

這樣項目日誌就配置好了，至於日誌的具體配置，修改logback.xml 裏面參數就可以了。和log4g差不多。

配置banner

最後既然是一個項目，當然得有點標誌性的東西，比如logo。springboot 給我們留下了一個彩蛋就是banner。我們可以在項目啓動的時候，顯示我們獨一無二的logo .
在application.properties 同目錄下創建 banner.txt

藝術字大家在網上自行搜索，這裏就不推薦啦哈哈。這樣我們在項目啓動的時候就會加載我們的logo. 算是給廣大的我們一點福利吧。

番外

今晚總算是寫完了，本來會早點的，但是不知道怎麼就弄這麼晚了。
今天項目的代碼也同步到github 上啦。
github地址：https://github.com/QuellanAn/zlflovemm

後續加油♡

歡迎大家關注個人公衆號 “程序員愛酸奶”

分享各種學習資料，包含java，linux，大數據等。資料包含視頻文檔以及源碼，同時分享本人及投遞的優質技術博文。

如果大家喜歡記得關注和分享喲❤