Spring Boot + MyBatis 多模塊搭建教程

時間  2020-12-01
標籤 html java mysql git web 面試 redis spring sql 後端 欄目 Spring 简体版
原文   原文鏈接
做者：楓本非凡
www.cnblogs.com/orzlin/p/9717399.html

1、前言

一、建立父工程

最近公司項目準備開始重構，框架選定爲 SpringBoot + Mybatis，本篇主要記錄了在IDEA中搭建 Spring Boot 多模塊項目的過程。html

一、開發工具及系統環境

二、項目目錄結構

  • biz層：
  • 業務邏輯層
  • dao層：數據持久層
  • web層：請求處理層

2、搭建步驟

一、建立父工程

IDEA 工具欄選擇菜單 File -> New -> Project...java

選擇Spring Initializr，Initializr默認選擇Default，點擊Nextmysql

填寫輸入框，點擊Nextgit

這步不須要選擇直接點Nextweb

點擊Finish建立項目面試

最終獲得的項目目錄結構以下redis

刪除無用的.mvn目錄、src目錄、mvnw及mvnw.cmd文件，最終只留.gitignore和pom.xmlspring

二、建立子模塊

選擇項目根目錄beta右鍵呼出菜單，選擇New -> Modulesql

選擇Maven，點擊Next後端

填寫ArifactId，點擊Next

修改Module name增長橫槓提高可讀性，點擊Finish

同理添加beta-dao、beta-web子模塊，最終獲得項目目錄結構以下圖

三、運行項目

在beta-web層建立com.yibao.beta.web包（注意：這是多層目錄結構並不是單個目錄名，com >> yibao >> beta >> web）並添加入口類BetaWebApplication.java

package com.yibao.beta.web;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author linjian
 * @date 2018/9/29
 */
@SpringBootApplication
public class BetaWebApplication {

    public static void main(String[] args) {
        SpringApplication.run(BetaWebApplication.class, args);
    }
}

在com.yibao.beta.web包中添加controller目錄並新建一個controller，添加test方法測試接口是否能夠正常訪問

package com.yibao.beta.web.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author linjian
 * @date 2018/9/29
 */
@RestController
@RequestMapping("demo")
public class DemoController {

    @GetMapping("test")
    public String test() {
        return "Hello World!";
    }
}

運行BetaWebApplication類中的main方法啓動項目，默認端口爲8080，訪問

http://localhost:8080/demo/test獲得以下效果

以上雖然項目能正常啓動，可是模塊間的依賴關係卻還未添加，下面繼續完善。微信搜索 web_resource 獲取更多推送

四、配置模塊間的依賴關係

各個子模塊的依賴關係：biz層依賴dao層，web層依賴biz層父pom文件中聲明全部子模塊依賴（dependencyManagement及dependencies的區別自行查閱文檔）

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.yibao.beta</groupId>
            <artifactId>beta-biz</artifactId>
            <version>${beta.version}</version>
        </dependency>
        <dependency>
            <groupId>com.yibao.beta</groupId>
            <artifactId>beta-dao</artifactId>
            <version>${beta.version}</version>
        </dependency>
        <dependency>
            <groupId>com.yibao.beta</groupId>
            <artifactId>beta-web</artifactId>
            <version>${beta.version}</version>
        </dependency>
    </dependencies>
</dependencyManagement>

其中${beta.version}定義在properties標籤中

在beta-web層中的pom文件中添加beta-biz依賴

<dependencies>
    <dependency>
        <groupId>com.yibao.beta</groupId>
        <artifactId>beta-biz</artifactId>
    </dependency>
</dependencies>

在beta-biz層中的pom文件中添加beta-dao依賴

<dependencies>
    <dependency>
        <groupId>com.yibao.beta</groupId>
        <artifactId>beta-dao</artifactId>
    </dependency>
</dependencies>

5 web層調用biz層接口測試

在beta-biz層建立com.yibao.beta.biz包，添加service目錄並在其中建立DemoService接口類，微信搜索 web_resource 獲取更多推送

package com.yibao.beta.biz.service;

/**
 * @author linjian
 * @date 2018/9/29
 */
public interface DemoService {

    String test();
}
package com.yibao.beta.biz.service.impl;

import com.yibao.beta.biz.service.DemoService;
import org.springframework.stereotype.Service;

/**
 * @author linjian
 * @date 2018/9/29
 */
@Service
public class DemoServiceImpl implements DemoService {

    @Override
    public String test() {
        return "test";
    }
}

DemoController經過@Autowired註解注入DemoService，修改DemoController的test方法使之調用DemoService的test方法，最終以下所示：

package com.yibao.beta.web.controller;

import com.yibao.beta.biz.service.DemoService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author linjian
 * @date 2018/9/29
 */
@RestController
@RequestMapping("demo")
public class DemoController {

    @Autowired
    private DemoService demoService;

    @GetMapping("test")
    public String test() {
        return demoService.test();
    }
}

再次運行BetaWebApplication類中的main方法啓動項目，發現以下報錯

***************************
APPLICATION FAILED TO START
***************************

Description:

Field demoService in com.yibao.beta.web.controller.DemoController required a bean of type 'com.yibao.beta.biz.service.DemoService' that could not be found.

Action:

Consider defining a bean of type 'com.yibao.beta.biz.service.DemoService' in your configuration.

緣由是找不到DemoService類，此時須要在BetaWebApplication入口類中增長包掃描，設置@SpringBootApplication註解中的scanBasePackages值爲com.yibao.beta，最終以下所示

package com.yibao.beta.web;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author linjian
 * @date 2018/9/29
 */
@SpringBootApplication(scanBasePackages = "com.yibao.beta")
@MapperScan("com.yibao.beta.dao.mapper")
public class BetaWebApplication {

    public static void main(String[] args) {
        SpringApplication.run(BetaWebApplication.class, args);
    }
}

設置完後從新運行main方法，項目正常啓動，訪問http://localhost:8080/demo/test獲得以下效果

6. 集成Mybatis

父pom文件中聲明mybatis-spring-boot-starter及lombok依賴

dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.22</version>
        </dependency>
    </dependencies>
</dependencyManagement>

在beta-dao層中的pom文件中添加上述依賴

<dependencies>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
</dependencies>

在beta-dao層建立com.yibao.beta.dao包，經過mybatis-genertaor工具生成dao層相關文件（DO、Mapper、xml），存放目錄以下

applicatio.properties文件添加jdbc及mybatis相應配置項

spring.datasource.driverClassName = com.mysql.jdbc.Driver
spring.datasource.url = jdbc:mysql://192.168.1.1/test?useUnicode=true&characterEncoding=utf-8
spring.datasource.username = test
spring.datasource.password = 123456

mybatis.mapper-locations = classpath:mybatis/*.xml
mybatis.type-aliases-package = com.yibao.beta.dao.entity

DemoService經過@Autowired註解注入UserMapper，修改DemoService的test方法使之調用UserMapper的selectByPrimaryKey方法，最終以下所示

package com.yibao.beta.biz.service.impl;

import com.yibao.beta.biz.service.DemoService;
import com.yibao.beta.dao.entity.UserDO;
import com.yibao.beta.dao.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

/**
 * @author linjian
 * @date 2018/9/29
 */
@Service
public class DemoServiceImpl implements DemoService {

    @Autowired
    private UserMapper userMapper;

    @Override
    public String test() {
        UserDO user = userMapper.selectByPrimaryKey(1);
        return user.toString();
    }
}

再次運行BetaWebApplication類中的main方法啓動項目，發現以下報錯

APPLICATION FAILED TO START
***************************

Description:

Field userMapper in com.yibao.beta.biz.service.impl.DemoServiceImpl required a bean of type 'com.yibao.beta.dao.mapper.UserMapper' that could not be found.

Action:

Consider defining a bean of type 'com.yibao.beta.dao.mapper.UserMapper' in your configuration.

緣由是找不到UserMapper類，此時須要在BetaWebApplication入口類中增長dao層包掃描，添加@MapperScan註解並設置其值爲com.yibao.beta.dao.mapper，最終以下所示

package com.yibao.beta.web;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author linjian
 * @date 2018/9/29
 */
@SpringBootApplication(scanBasePackages = "com.yibao.beta")
@MapperScan("com.yibao.beta.dao.mapper")
public class BetaWebApplication {

    public static void main(String[] args) {
        SpringApplication.run(BetaWebApplication.class, args);
    }
}

設置完後從新運行main方法，項目正常啓動，訪問http://localhost:8080/demo/test獲得以下效果

至此，一個簡單的 Spring Boot + Mybatis多模塊項目已經搭建完畢，咱們也經過啓動項目調用接口驗證其正確性。

3、總結

一個井井有條的多模塊工程結構不只方便維護，並且有利於後續微服務化。在此結構的基礎上還能夠擴展common層（公共組件）、server層（如dubbo對外提供的服務）微信搜索 web_resource 獲取更多推送此爲項目重構的第一步，後續還會的框架中集成logback、disconf、redis、dubbo等組件。

4、未提到的坑

在搭建過程當中還遇到一個maven私服的問題，緣由是公司內部的maven私服配置的中央倉庫爲阿里的遠程倉庫，它與maven自帶的遠程倉庫相比有些jar包版本並不全，致使在搭建過程當中好幾回由於沒拉到相應jar包致使項目啓動不了。

關注公衆號Java技術棧回覆"面試"獲取我整理的2020最全面試題及答案。

推薦去個人博客閱讀更多：

1.Java JVM、集合、多線程、新特性系列教程

2.Spring MVC、Spring Boot、Spring Cloud 系列教程

3.Maven、Git、Eclipse、Intellij IDEA 系列工具教程

4.Java、後端、架構、阿里巴巴等大廠最新面試題

以爲不錯，別忘了點贊+轉發哦！

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程