本文主要讲解mall整合SpringBoot+MyBatis搭建基本骨架，以商品品牌为例实现基本的CRUD操作及通过PageHelper实现分页查询。

mysql数据库环境搭建

项目使用框架介绍

SpringBoot

SpringBoot可以让你快速构建基于Spring的Web应用程序，内置多种Web容器(如Tomcat)，通过启动入口程序的main函数即可运行。

PagerHelper

MyBatis分页插件，简单的几行代码就能实现分页，在与SpringBoot整合时，只要整合了PagerHelper就自动整合了MyBatis。

  1. PageHelper.startPage(pageNum, pageSize);
  2. //之后进行查询操作将自动进行分页
  3. List<PmsBrand> brandList = brandMapper.selectByExample(new PmsBrandExample());
  4. //通过构造PageInfo对象获取分页信息，如当前页码，总页数，总条数
  5. PageInfo<PmsBrand> pageInfo = new PageInfo<PmsBrand>(list);

Druid

alibaba开源的数据库连接池，号称Java语言中最好的数据库连接池。

Mybatis generator

MyBatis的代码生成器，可以根据数据库生成model、mapper.xml、mapper接口和Example，通常情况下的单表查询不用再手写mapper。

项目搭建

使用IDEA初始化一个SpringBoot项目

mall整合SpringBoot MyBatis搭建基本骨架 - 图1

添加项目依赖

在pom.xml中添加相关依赖。

  1. <parent>
  2.         <groupId>org.springframework.boot</groupId>
  3.         <artifactId>spring-boot-starter-parent</artifactId>
  4.         <version>2.1.3.RELEASE</version>
  5.         <relativePath/> <!-- lookup parent from repository -->
  6.     </parent>
  7.     <dependencies>
  8.         <!--SpringBoot通用依赖模块-->
  9.         <dependency>
  10.             <groupId>org.springframework.boot</groupId>
  11.             <artifactId>spring-boot-starter-web</artifactId>
  12.         </dependency>
  13.         <dependency>
  14.             <groupId>org.springframework.boot</groupId>
  15.             <artifactId>spring-boot-starter-actuator</artifactId>
  16.         </dependency>
  17.         <dependency>
  18.             <groupId>org.springframework.boot</groupId>
  19.             <artifactId>spring-boot-starter-aop</artifactId>
  20.         </dependency>
  21.         <dependency>
  22.             <groupId>org.springframework.boot</groupId>
  23.             <artifactId>spring-boot-starter-test</artifactId>
  24.             <scope>test</scope>
  25.         </dependency>
  26.         <!--MyBatis分页插件-->
  27.         <dependency>
  28.             <groupId>com.github.pagehelper</groupId>
  29.             <artifactId>pagehelper-spring-boot-starter</artifactId>
  30.             <version>1.2.10</version>
  31.         </dependency>
  32.         <!--集成druid连接池-->
  33.         <dependency>
  34.             <groupId>com.alibaba</groupId>
  35.             <artifactId>druid-spring-boot-starter</artifactId>
  36.             <version>1.1.10</version>
  37.         </dependency>
  38.         <!-- MyBatis 生成器 -->
  39.         <dependency>
  40.             <groupId>org.mybatis.generator</groupId>
  41.             <artifactId>mybatis-generator-core</artifactId>
  42.             <version>1.3.3</version>
  43.         </dependency>
  44.         <!--Mysql数据库驱动-->
  45.         <dependency>
  46.             <groupId>mysql</groupId>
  47.             <artifactId>mysql-connector-java</artifactId>
  48.             <version>8.0.15</version>
  49.         </dependency>
  50.     </dependencies>

修改SpringBoot配置文件

在application.yml中添加数据源配置和MyBatis的mapper.xml的路径配置。

  1. server:
  2.   port: 8080
  4. spring:
  5.   datasource:
  6.     url: jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
  7.     username: root
  8.     password: root
  10. mybatis:
  11.   mapper-locations:
  12.     - classpath:mapper/*.xml
  13.     - classpath*:com/**/mapper/*.xml

项目结构说明

mall整合SpringBoot MyBatis搭建基本骨架 - 图2

Mybatis generator 配置文件

配置数据库连接，Mybatis generator生成model、mapper接口及mapper.xml的路径。

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE generatorConfiguration
  3.         PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
  4.         "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
  6. <generatorConfiguration>
  7.     <properties resource="generator.properties"/>
  8.     <context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat">
  9.         <property name="beginningDelimiter" value="`"/>
  10.         <property name="endingDelimiter" value="`"/>
  11.         <property name="javaFileEncoding" value="UTF-8"/>
  12.         <!-- 为模型生成序列化方法-->
  13.         <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
  14.         <!-- 为生成的Java模型创建一个toString方法 -->
  15.         <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
  16.         <!--可以自定义生成model的代码注释-->
  17.         <commentGenerator type="com.macro.mall.tiny.mbg.CommentGenerator">
  18.             <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
  19.             <property name="suppressAllComments" value="true"/>
  20.             <property name="suppressDate" value="true"/>
  21.             <property name="addRemarkComments" value="true"/>
  22.         </commentGenerator>
  23.         <!--配置数据库连接-->
  24.         <jdbcConnection driverClass="${jdbc.driverClass}"
  25.                         connectionURL="${jdbc.connectionURL}"
  26.                         userId="${jdbc.userId}"
  27.                         password="${jdbc.password}">
  28.             <!--解决mysql驱动升级到8.0后不生成指定数据库代码的问题-->
  29.             <property name="nullCatalogMeansCurrent" value="true" />
  30.         </jdbcConnection>
  31.         <!--指定生成model的路径-->
  32.         <javaModelGenerator targetPackage="com.macro.mall.tiny.mbg.model" targetProject="mall-tiny-01\src\main\java"/>
  33.         <!--指定生成mapper.xml的路径-->
  34.         <sqlMapGenerator targetPackage="com.macro.mall.tiny.mbg.mapper" targetProject="mall-tiny-01\src\main\resources"/>
  35.         <!--指定生成mapper接口的的路径-->
  36.         <javaClientGenerator type="XMLMAPPER" targetPackage="com.macro.mall.tiny.mbg.mapper"
  37.                              targetProject="mall-tiny-01\src\main\java"/>
  38.         <!--生成全部表tableName设为%-->
  39.         <table tableName="pms_brand">
  40.             <generatedKey column="id" sqlStatement="MySql" identity="true"/>
  41.         </table>
  42.     </context>
  43. </generatorConfiguration>

运行Generator的main函数生成代码

  1. package com.macro.mall.tiny.mbg;
  3. import org.mybatis.generator.api.MyBatisGenerator;
  4. import org.mybatis.generator.config.Configuration;
  5. import org.mybatis.generator.config.xml.ConfigurationParser;
  6. import org.mybatis.generator.internal.DefaultShellCallback;
  8. import java.io.InputStream;
  9. import java.util.ArrayList;
  10. import java.util.List;
  12. /**
  13.  * 用于生产MBG的代码
  14.  * Created by macro on 2018/4/26.
  15.  */
  16. public class Generator {
  17.     public static void main(String[] args) throws Exception {
  18.         //MBG 执行过程中的警告信息
  19.         List<String> warnings = new ArrayList<String>();
  20.         //当生成的代码重复时，覆盖原代码
  21.         boolean overwrite = true;
  22.         //读取我们的 MBG 配置文件
  23.         InputStream is = Generator.class.getResourceAsStream("/generatorConfig.xml");
  24.         ConfigurationParser cp = new ConfigurationParser(warnings);
  25.         Configuration config = cp.parseConfiguration(is);
  26.         is.close();
  28.         DefaultShellCallback callback = new DefaultShellCallback(overwrite);
  29.         //创建 MBG
  30.         MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
  31.         //执行生成代码
  32.         myBatisGenerator.generate(null);
  33.         //输出警告信息
  34.         for (String warning : warnings) {
  35.             System.out.println(warning);
  36.         }
  37.     }
  38. }

添加MyBatis的Java配置

用于配置需要动态生成的mapper接口的路径

  1. package com.macro.mall.tiny.config;
  3. import org.mybatis.spring.annotation.MapperScan;
  4. import org.springframework.context.annotation.Configuration;
  6. /**
  7.  * MyBatis配置类
  8.  * Created by macro on 2019/4/8.
  9.  */
  10. @Configuration
  11. @MapperScan("com.macro.mall.tiny.mbg.mapper")
  12. public class MyBatisConfig {
  13. }

实现Controller中的接口

实现PmsBrand表中的添加、修改、删除及分页查询接口。

  1. package com.macro.mall.tiny.controller;
  3. import com.macro.mall.tiny.common.api.CommonPage;
  4. import com.macro.mall.tiny.common.api.CommonResult;
  5. import com.macro.mall.tiny.mbg.model.PmsBrand;
  6. import com.macro.mall.tiny.service.PmsBrandService;
  7. import org.slf4j.Logger;
  8. import org.slf4j.LoggerFactory;
  9. import org.springframework.beans.factory.annotation.Autowired;
  10. import org.springframework.stereotype.Controller;
  11. import org.springframework.validation.BindingResult;
  12. import org.springframework.web.bind.annotation.*;
  14. import java.util.List;
  17. /**
  18.  * 品牌管理Controller
  19.  * Created by macro on 2019/4/19.
  20.  */
  21. @Controller
  22. @RequestMapping("/brand")
  23. public class PmsBrandController {
  24.     @Autowired
  25.     private PmsBrandService demoService;
  27.     private static final Logger LOGGER = LoggerFactory.getLogger(PmsBrandController.class);
  29.     @RequestMapping(value = "listAll", method = RequestMethod.GET)
  30.     @ResponseBody
  31.     public CommonResult<List<PmsBrand>> getBrandList() {
  32.         return CommonResult.success(demoService.listAllBrand());
  33.     }
  35.     @RequestMapping(value = "/create", method = RequestMethod.POST)
  36.     @ResponseBody
  37.     public CommonResult createBrand(@RequestBody PmsBrand pmsBrand) {
  38.         CommonResult commonResult;
  39.         int count = demoService.createBrand(pmsBrand);
  40.         if (count == 1) {
  41.             commonResult = CommonResult.success(pmsBrand);
  42.             LOGGER.debug("createBrand success:{}", pmsBrand);
  43.         } else {
  44.             commonResult = CommonResult.failed("操作失败");
  45.             LOGGER.debug("createBrand failed:{}", pmsBrand);
  46.         }
  47.         return commonResult;
  48.     }
  50.     @RequestMapping(value = "/update/{id}", method = RequestMethod.POST)
  51.     @ResponseBody
  52.     public CommonResult updateBrand(@PathVariable("id") Long id, @RequestBody PmsBrand pmsBrandDto, BindingResult result) {
  53.         CommonResult commonResult;
  54.         int count = demoService.updateBrand(id, pmsBrandDto);
  55.         if (count == 1) {
  56.             commonResult = CommonResult.success(pmsBrandDto);
  57.             LOGGER.debug("updateBrand success:{}", pmsBrandDto);
  58.         } else {
  59.             commonResult = CommonResult.failed("操作失败");
  60.             LOGGER.debug("updateBrand failed:{}", pmsBrandDto);
  61.         }
  62.         return commonResult;
  63.     }
  65.     @RequestMapping(value = "/delete/{id}", method = RequestMethod.GET)
  66.     @ResponseBody
  67.     public CommonResult deleteBrand(@PathVariable("id") Long id) {
  68.         int count = demoService.deleteBrand(id);
  69.         if (count == 1) {
  70.             LOGGER.debug("deleteBrand success :id={}", id);
  71.             return CommonResult.success(null);
  72.         } else {
  73.             LOGGER.debug("deleteBrand failed :id={}", id);
  74.             return CommonResult.failed("操作失败");
  75.         }
  76.     }
  78.     @RequestMapping(value = "/list", method = RequestMethod.GET)
  79.     @ResponseBody
  80.     public CommonResult<CommonPage<PmsBrand>> listBrand(@RequestParam(value = "pageNum", defaultValue = "1") Integer pageNum,
  81.                                                         @RequestParam(value = "pageSize", defaultValue = "3") Integer pageSize) {
  82.         List<PmsBrand> brandList = demoService.listBrand(pageNum, pageSize);
  83.         return CommonResult.success(CommonPage.restPage(brandList));
  84.     }
  86.     @RequestMapping(value = "/{id}", method = RequestMethod.GET)
  87.     @ResponseBody
  88.     public CommonResult<PmsBrand> brand(@PathVariable("id") Long id) {
  89.         return CommonResult.success(demoService.getBrand(id));
  90.     }
  91. }

添加Service接口

  1. package com.macro.mall.tiny.service;
  4. import com.macro.mall.tiny.mbg.model.PmsBrand;
  6. import java.util.List;
  8. /**
  9.  * PmsBrandService
  10.  * Created by macro on 2019/4/19.
  11.  */
  12. public interface PmsBrandService {
  13.     List<PmsBrand> listAllBrand();
  15.     int createBrand(PmsBrand brand);
  17.     int updateBrand(Long id, PmsBrand brand);
  19.     int deleteBrand(Long id);
  21.     List<PmsBrand> listBrand(int pageNum, int pageSize);
  23.     PmsBrand getBrand(Long id);
  24. }

实现Service接口

  1. package com.macro.mall.tiny.service.impl;
  3. import com.github.pagehelper.PageHelper;
  4. import com.macro.mall.tiny.mbg.mapper.PmsBrandMapper;
  5. import com.macro.mall.tiny.mbg.model.PmsBrand;
  6. import com.macro.mall.tiny.mbg.model.PmsBrandExample;
  7. import com.macro.mall.tiny.service.PmsBrandService;
  8. import org.springframework.beans.factory.annotation.Autowired;
  9. import org.springframework.stereotype.Service;
  11. import java.util.List;
  13. /**
  14.  * PmsBrandService实现类
  15.  * Created by macro on 2019/4/19.
  16.  */
  17. @Service
  18. public class PmsBrandServiceImpl implements PmsBrandService {
  19.     @Autowired
  20.     private PmsBrandMapper brandMapper;
  22.     @Override
  23.     public List<PmsBrand> listAllBrand() {
  24.         return brandMapper.selectByExample(new PmsBrandExample());
  25.     }
  27.     @Override
  28.     public int createBrand(PmsBrand brand) {
  29.         return brandMapper.insertSelective(brand);
  30.     }
  32.     @Override
  33.     public int updateBrand(Long id, PmsBrand brand) {
  34.         brand.setId(id);
  35.         return brandMapper.updateByPrimaryKeySelective(brand);
  36.     }
  38.     @Override
  39.     public int deleteBrand(Long id) {
  40.         return brandMapper.deleteByPrimaryKey(id);
  41.     }
  43.     @Override
  44.     public List<PmsBrand> listBrand(int pageNum, int pageSize) {
  45.         PageHelper.startPage(pageNum, pageSize);
  46.         return brandMapper.selectByExample(new PmsBrandExample());
  47.     }
  49.     @Override
  50.     public PmsBrand getBrand(Long id) {
  51.         return brandMapper.selectByPrimaryKey(id);
  52.     }
  53. }

项目源码地址

https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-01