spring+springmvc+mybatis-plus 純注解開發

最近剛完成一個項目，剛好有一點時間，來完成基於spring+springmvc+mybatis-plus 純注解開發

一、創建工程、導入依賴

1、新建一個基於maven的web工程，使用JDK1.8

 

 

 

 

 

 

 

 

 

 2、調整目錄結構

2.1、新建java

 

 

 

 

2.2、新建resources

 

 

2.3、刪除web.xml、構建基礎包

 

 

 

 

 

 2.4、工程目錄構建完成展示

2、配置tomcat服務器

2.1、服務器配置

 

 

 

 

 

 

 

 

 

 2.2、測試服務器配置

 

 

3、pom.xml文件配置

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>5.1.5.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>5.1.5.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-beans</artifactId>
      <version>5.1.5.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>5.1.5.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.1.5.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-aop</artifactId>
      <version>5.1.5.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-tx</artifactId>
      <version>5.1.5.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-jdbc</artifactId>
      <version>5.1.5.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis-spring</artifactId>
      <version>1.3.2</version>
    </dependency>
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>3.4.6</version>
    </dependency>
    <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus</artifactId>
      <version>3.0.7.1</version>
    </dependency>
    <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-generator</artifactId>
      <version>3.0.7.1</version>
    </dependency>
    <dependency>
      <groupId>org.apache.velocity</groupId>
      <artifactId>velocity-engine-core</artifactId>
      <version>2.0</version>
    </dependency>
    <dependency>
      <groupId>org.apache.commons</groupId>
      <artifactId>commons-lang3</artifactId>
      <version>3.7</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-core</artifactId>
      <version>2.9.8</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>2.9.8</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-annotations</artifactId>
      <version>2.9.8</version>
    </dependency>
    <dependency>
      <groupId>com.oracle</groupId>
      <artifactId>ojdbc6</artifactId>
      <version>11.2.0.1.0</version>
    </dependency>
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>6.0.5</version>
    </dependency>
    <dependency>
      <groupId>com.mchange</groupId>
      <artifactId>c3p0</artifactId>
      <version>0.9.5.2</version>
    </dependency>
    <dependency>
      <groupId>com.mchange</groupId>
      <artifactId>c3p0</artifactId>
      <version>0.9.5.2</version>
    </dependency>
    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>druid</artifactId>
      <version>1.1.10</version>
    </dependency>
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.18.8</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.1.0</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <build>
    <finalName>loginannotationday02</finalName>
    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
      <plugins>
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
        <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-war-plugin</artifactId>
          <version>3.2.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>

二、編寫mybatis-plus的代碼生成工具

調整目錄結構

 

 

 在util下新建mybatis代碼生成工具類

 

 

 mybatisplusutil代碼如下

package com.cxw.util;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.converts.OracleTypeConvert;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.IColumnType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.VelocityTemplateEngine;
import org.apache.commons.lang3.StringUtils;

import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;

public class MybatisPlusUtil{

    /**
     * <p>
     * 讀取控制台內容
     * </p>
     */
    static String Scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("請輸入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotEmpty(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("請輸入正確的" + tip + "！");
    }

    public static void main(String[] args) {
        //代碼生成器
        AutoGenerator autoGenerator = new AutoGenerator();

        //全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        final  String projectPath = System.getProperty("user.dir");
        globalConfig.setOutputDir(projectPath + "/src/main/java");
        globalConfig.setAuthor("cxw");
//        globalConfig.setOpen(false);
        //是否覆蓋文件
        globalConfig.setFileOverride(true);
        //不需要ActiveRecord特性的請改為false
        globalConfig.setActiveRecord(false);
        //XML 二級緩存
        globalConfig.setEnableCache(false);
        //XML ResultMap
        globalConfig.setBaseResultMap(true);
        //XML columList
        globalConfig.setBaseColumnList(false);
        autoGenerator.setGlobalConfig(globalConfig);

        //數據源配置
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setDbType(DbType.MYSQL);
        //類型轉換
        dataSourceConfig.setTypeConvert(new OracleTypeConvert(){
            @Override
            public IColumnType processTypeConvert(GlobalConfig globalConfig, String fieldType) {
                return super.processTypeConvert(globalConfig, fieldType);
            }
        });
        dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/cxwdb?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8&useSSL=false");
        dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSourceConfig.setUsername("root");
        dataSourceConfig.setPassword("123456");
        autoGenerator.setDataSource(dataSourceConfig);



        //包配置
        final PackageConfig packageConfig = new PackageConfig();
        //基礎包名
        packageConfig.setParent("com.cxw");
        //模塊名
        packageConfig.setModuleName(Scanner("模塊名"));
        packageConfig.setService("service");
        packageConfig.setServiceImpl("service.impl");
        packageConfig.setEntity("entity");
        packageConfig.setController("controller");
        packageConfig.setMapper("mapper");
        packageConfig.setXml("mapper");
        autoGenerator.setPackageInfo(packageConfig);

        // 自定義配置
        InjectionConfig injectionConfig = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };
        List<FileOutConfig> focList = new ArrayList<>();
        focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定義輸入文件名稱
                return projectPath + "/src/main/resources/mapper/" + packageConfig.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        injectionConfig.setFileOutConfigList(focList);
        autoGenerator.setCfg(injectionConfig);
        autoGenerator.setTemplate(new TemplateConfig().setXml(null));

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(false);
        strategy.setRestControllerStyle(true);
        strategy.setCapitalMode(true);
        strategy.setInclude(Scanner("表名"));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setEntityTableFieldAnnotationEnable(true);
//        strategy.setTablePrefix("n_");
        autoGenerator.setStrategy(strategy);
        autoGenerator.setTemplateEngine(new VelocityTemplateEngine());
        autoGenerator.execute();
    }
}

通過工具類生成代碼

 

 

 生成后目錄結構如下

三、spring+springmvc+mybatis-plus 純注解搭建

1、構建核心配置文件

package com.cxw.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import org.springframework.stereotype.Controller;


@Configuration
@ComponentScan(basePackages = {"com.cxw"},excludeFilters = {
        @ComponentScan.Filter(type = FilterType.ANNOTATION,value = Controller.class),
})
/**
 * 核心配置文件
 */
public class AppConfig {

}

2、構建springmvc配置文件

package com.cxw.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import org.springframework.stereotype.Controller;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

@Configuration
@ComponentScan(basePackages = "com.cxw",
    includeFilters = {@ComponentScan.Filter(type = FilterType.ANNOTATION,
    value = Controller.class)})
@EnableWebMvc
/**
 * springmvc配置文件
 */
public class WebConfig {

}

3、構建數據庫配置文件

 

 

 

spring.datasource.user=root
spring.datasource.password=123456
spring.datasource.driver=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/cxwdb?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8&useSSL=false

4、構建數據庫配置文件關聯文件

package com.cxw.config;

import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@PropertySource("classpath:db.properties")
@Data
@Configuration
public class PropertyConfig {

    @Value("${spring.datasource.url}")
    private String url;
    @Value("${spring.datasource.driver}")
    private String driver;
    @Value("${spring.datasource.user}")
    private String user;
    @Value("${spring.datasource.password}")
    private String password;

}

5、構建mybatisplus配置文件

package com.cxw.config;

import com.alibaba.druid.pool.DruidDataSource;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

@Configuration
@MapperScan(value = "com.cxw.studentinfo.mapper")
public class MybatisPlusConfig {
    /**
     * 配置數據源
     */
    @Bean
    public DataSource dataSource(PropertyConfig propertyConfig){
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setUsername(propertyConfig.getUser());
        dataSource.setPassword(propertyConfig.getPassword());
        dataSource.setUrl(propertyConfig.getUrl());
        dataSource.setDriverClassName(propertyConfig.getDriver());
        return dataSource;
    }

    /*@Bean
    public DataSource dataSource(PropertyConfig propertyConfig) throws Exception {
        ComboPooledDataSource dataSource = new ComboPooledDataSource();
        dataSource.setUser(propertyConfig.getUser());
        dataSource.setPassword(propertyConfig.getPassword());
        dataSource.setJdbcUrl(propertyConfig.getUrl());
        dataSource.setDriverClass(propertyConfig.getDriver());
        return dataSource;
    }*/

    /**
     * 獲得getMybatisSqlSessionFactoryBean
     * @return
     */
    @Bean
    public MybatisSqlSessionFactoryBean sqlSessionFactory(DataSource dataSource){
        MybatisSqlSessionFactoryBean mybatisPlus  = new MybatisSqlSessionFactoryBean();
        mybatisPlus.setDataSource(dataSource);
        return mybatisPlus;
    }


    /**
     * 設置mapper文件的掃描路徑
     * @return
     */
   /* @Bean
    public MapperScannerConfigurer getMapperScannerConfigurer(){
        MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
        mapperScannerConfigurer.setBasePackage("com.cxw.studentinfo,mapper");
        return mapperScannerConfigurer;
    }*/

    /**
     * 分頁插件
     * @return
     */
    @Bean
    public PaginationInterceptor getPaginationInterceptor(){
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        //自定義方言 可以沒有
        paginationInterceptor.setDialectType("mysql");
        return paginationInterceptor;
    }

}

6、構建核心初始化文件

package com.cxw.config;

import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;


/**
 * web.xml替代文件，可以簡單理解為相web.xml文件
 */
public class WebInit extends AbstractAnnotationConfigDispatcherServletInitializer {
    //將bean加入容器
    @Override
    protected Class<?>[] getRootConfigClasses() {
        //這里可以配置需要加入容器的Bean,同樣可以聲明配置類,然后加Bean
        return new Class[]{AppConfig.class,MybatisPlusConfig.class};
    }

    //這個也是相當於將Bean加入容器
    //相當於springmvc容器
    // url映射配置,返回spring的配置文件
    //這里WebConfig主要是配置DispatcherSerlvet,視頻解析器,JSON等
    @Override
    protected Class<?>[] getServletConfigClasses() {
        //return null;
        return new Class[]{WebConfig.class};
    }
    //攔截請求匹配,只攔截/
    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
}

四、邏輯代碼編寫

1、controller代碼

package com.cxw.studentinfo.controller;


import com.cxw.studentinfo.entity.TblStudent;
import com.cxw.studentinfo.service.ITblStudentService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;

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

/**
 * <p>
 *  前端控制器
 * </p>
 *
 * @author cxw
 * @since 2019-09-25
 */
@RestController
@RequestMapping("/studentinfo/tbl-student")
public class TblStudentController {
    private ITblStudentService iTblStudentService;

    @Autowired
    public TblStudentController(ITblStudentService iTblStudentService){
        this.iTblStudentService = iTblStudentService;
    }

    public TblStudentController(){

    }

    @RequestMapping("/gettblstudentbyid/{id}")
    public TblStudent getTblStudentById(@PathVariable("id") String id){
        TblStudent student = iTblStudentService.getById(id);
        return student;
    }

}

2、serivce代碼

package com.cxw.studentinfo.service;

import com.cxw.studentinfo.entity.TblStudent;
import com.baomidou.mybatisplus.extension.service.IService;

/**
 * <p>
 *  服務類
 * </p>
 *
 * @author cxw
 * @since 2019-09-25
 */
public interface ITblStudentService extends IService<TblStudent> {

}

3、impl代碼

package com.cxw.studentinfo.service.impl;

import com.cxw.studentinfo.entity.TblStudent;
import com.cxw.studentinfo.mapper.TblStudentMapper;
import com.cxw.studentinfo.service.ITblStudentService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

/**
 * <p>
 *  服務實現類
 * </p>
 *
 * @author cxw
 * @since 2019-09-25
 */
@Service
public class TblStudentServiceImpl extends ServiceImpl<TblStudentMapper, TblStudent> implements ITblStudentService {

    private TblStudentMapper tblStudentMapper;

    @Autowired
    public TblStudentServiceImpl(TblStudentMapper tblStudentMapper){
        this.tblStudentMapper = tblStudentMapper;
    }

    public TblStudentServiceImpl( ){

    }

4、mapper代碼

package com.cxw.studentinfo.mapper;

import com.cxw.studentinfo.entity.TblStudent;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.springframework.stereotype.Service;

/**
 * <p>
 *  Mapper 接口
 * </p>
 *
 * @author cxw
 * @since 2019-09-25
 */
@Service
public interface TblStudentMapper extends BaseMapper<TblStudent> {

}

5、entity代碼

package com.cxw.studentinfo.entity;

import com.baomidou.mybatisplus.annotation.TableId;
import java.time.LocalDateTime;
import com.baomidou.mybatisplus.annotation.TableField;
import java.io.Serializable;

/**
 * <p>
 * 
 * </p>
 *
 * @author cxw
 * @since 2019-09-25
 */
public class TblStudent implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 主鍵
     */
    @TableId("id")
    private String id;

    /**
     * 姓名
     */
    @TableField("name")
    private String name;

    /**
     * 年齡
     */
    @TableField("age")
    private String age;

    /**
     * 性別
     */
    @TableField("sex")
    private String sex;

    /**
     * 數據新增用戶id
     */
    @TableField("datainsuserid")
    private String datainsuserid;

    /**
     * 數據新增時間
     */
    @TableField("datainstime")
    private LocalDateTime datainstime;


    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAge() {
        return age;
    }

    public void setAge(String age) {
        this.age = age;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public String getDatainsuserid() {
        return datainsuserid;
    }

    public void setDatainsuserid(String datainsuserid) {
        this.datainsuserid = datainsuserid;
    }

    public LocalDateTime getDatainstime() {
        return datainstime;
    }

    public void setDatainstime(LocalDateTime datainstime) {
        this.datainstime = datainstime;
    }

    @Override
    public String toString() {
        return "TblStudent{" +
        "id=" + id +
        ", name=" + name +
        ", age=" + age +
        ", sex=" + sex +
        ", datainsuserid=" + datainsuserid +
        ", datainstime=" + datainstime +
        "}";
    }
}

6、mapper.xml代碼

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.cxw.studentinfo.mapper.TblStudentMapper">

    <!-- 通用查詢映射結果 -->
    <resultMap id="BaseResultMap" type="com.cxw.studentinfo.entity.TblStudent">
        <id column="id" property="id" />
        <result column="name" property="name" />
        <result column="age" property="age" />
        <result column="sex" property="sex" />
        <result column="datainsuserid" property="datainsuserid" />
        <result column="datainstime" property="datainstime" />
    </resultMap>

</mapper>

五、測試

1、數據庫查詢結果展示

 

 

2、運行程序，訪問后結構展示

六、總結和疑問

1、使用代碼生成器的時候，如果使用的是Oracle數據庫，表名似乎需要大寫才能生成

2、配置mapper掃包的時候，如果使用非注解的形式，似乎會造成重復掃包，導致會找不到service文件

以上兩個問題是我在構建項目的時候遇到的問題