Springboot整合mybatis完整版（企业级基本demo）

忘是亡心i 2023-06-18 08:59 6阅读 0赞

### 文章目录 ###

*   *  项目目录结构
     *  数据库sql
     *  pom依赖
     *  配置文件
     *  config包下配置类
     *  编写测试po，dao,mapper
     *  使用SpringBootTest测试
     *  完整项目测试

## 项目目录结构 ##

![在这里插入图片描述][20191201184602825.png]

## 数据库sql ##

*  数据库:shopping\_user
 *  使用测试表:sp\_user
 *  建表语句：

CREATE TABLE `sp_user` (
      `id` int(20) auto_increment COMMENT 'ID',
      `iphone` varchar(100) DEFAULT NULL COMMENT '手机号码',
      `password` varchar(100) DEFAULT NULL COMMENT '密码',
      `name` varchar(100) DEFAULT NULL COMMENT '昵称',
      `sex` varchar(2) DEFAULT NULL COMMENT '性别',
      PRIMARY KEY (`id`) 
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='用户';

*  测试数据

INSERT INTO `shopping_user`.`sp_user`(`id`, `iphone`, `password`, `name`, `sex`) VALUES ('1', '124545434', '12134', '阿离', '女');
    INSERT INTO `shopping_user`.`sp_user`(`id`, `iphone`, `password`, `name`, `sex`) VALUES ('2', '124214124', '2131242', '奏', '女');

## pom依赖 ##

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.7.RELEASE</version>
            <relativePath/> 
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>springcloud-shopping-mybatis</artifactId>
    
        <properties>
            <java.version>1.8</java.version>
            <mysql.version>8.0.15</mysql.version>
            <druid.version>1.1.18</druid.version>
            <mybatis.version>2.0.0</mybatis.version>
            <lombok.version>1.16.16</lombok.version>
            <fastjson.version>1.2.58</fastjson.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>${ mysql.version}</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid-spring-boot-starter</artifactId>
                <version>${ druid.version}</version>
            </dependency>
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>${ mybatis.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>${ lombok.version}</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>${ fastjson.version}</version>
            </dependency>
            <dependency>
                <groupId>org.aspectj</groupId>
                <artifactId>aspectjweaver</artifactId>
                <version>1.8.10</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    
    </project>

## 配置文件 ##

主要配置文件有三个：  
![在这里插入图片描述][20191201204653619.png]  
`application.properties`

logging.level.root=INFO
    log.dir=/apps/logs/
    ##页面配置
    spring.thymeleaf.prefix=classpath:/templates/
    spring.thymeleaf.suffix=.html
    spring.thymeleaf.mode=LEGACYHTML5
    spring.thymeleaf.encoding=UTF-8
    spring.thymeleaf.servlet.content-type=content-type=text/html
    spring.thymeleaf.cache=false
    spring.resources.chain.strategy.content.enabled=true
    spring.resources.chain.strategy.content.paths=/** spring.application.name=shopping.user server.servlet.context-path=/user/ ## 配置文件使用sit spring.profiles.active=sit server.port=8088 #server.tomcat.uri-encoding=UTF-8 #spring.http.encoding.charset=UTF-8 #spring.http.encoding.enabled=true #spring.http.encoding.force=true #spring.messages.encoding=UTF-8

`application-sit.properties`

#JDBC配置
    spring.datasource.druid.url= jdbc:mysql://localhost:3306/shopping_user?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
    spring.datasource.druid.username=root
    spring.datasource.druid.password=123456
    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
    
    #连接池配置,配置初始化大小、最小、最大
    spring.datasource.druid.initial-size=2
    spring.datasource.druid.max-active=20
    spring.datasource.druid.min-idle=2
    spring.datasource.druid.max-wait=60000
    spring.datasource.druid.pool-prepared-statements=true
    spring.datasource.druid.max-pool-prepared-statement-per-connection-size=20
    spring.datasource.druid.max-open-prepared-statements=20
    spring.datasource.druid.validation-query=SELECT 1 FROM DUAL
    spring.datasource.druid.test-on-borrow=false
    spring.datasource.druid.test-on-return=false
    spring.datasource.druid.test-while-idle=true
    spring.datasource.druid.time-between-eviction-runs-millis=60000
    spring.datasource.druid.min-evictable-idle-time-millis=300000
    spring.datasource.druid.max-evictable-idle-time-millis=900000
    spring.datasource.druid.filters=stat,wall,slf4j
    spring.datasource.druid.async-init=true
    #监控配置
    spring.datasource.druid.filter.stat.log-slow-sql=true
    spring.datasource.druid.filter.stat.slow-sql-millis=5000
    spring.datasource.druid.filter.stat.merge-sql=true
    spring.datasource.druid.filter.stat.db-type=mysql
    spring.datasource.druid.filter.stat.enabled=true
    #配置slf4j
    spring.datasource.druid.filter.slf4j.enabled=true
    spring.datasource.druid.filter.slf4j.statement-prepare-after-log-enabled=false
    spring.datasource.druid.filter.slf4j.statement-create-after-log-enabled=false
    spring.datasource.druid.filter.slf4j.statement-close-after-log-enabled=false
    spring.datasource.druid.filter.slf4j.result-set-open-after-log-enabled=false
    spring.datasource.druid.filter.slf4j.result-set-close-after-log-enabled=false
    #配置web-stat-filter(为了安全不配置)
    #mybatis-和扫描po(model)包
    mybatis.config-location=classpath:mybatis-config.xml
    mybatis.mapper-locations=classpath:mapper/*.xml mybatis.type-aliases-package=com.mybatis.po logging.level.com.mybatis.dao=debug

`mybatis-config.xml`

<?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>
        <settings>
            <setting name="jdbcTypeForNull" value="NULL"/>
        </settings>
        <typeAliases>
            <typeAlias alias="Integer" type="java.lang.Integer" />
            <typeAlias alias="Long" type="java.lang.Long" />
            <typeAlias alias="HashMap" type="java.util.HashMap" />
            <typeAlias alias="LinkedHashMap" type="java.util.LinkedHashMap" />
            <typeAlias alias="ArrayList" type="java.util.ArrayList" />
            <typeAlias alias="LinkedList" type="java.util.LinkedList" />
        </typeAliases>
    </configuration>

*  application.properties为主配置文件，如果用sit环境只需在`application.properties`指定为`spring.profiles.active=sit`,如果有用到uat加入配置文件`application-uat.properties`,指定`spring.profiles.active=uat`

## config包下配置类 ##

![在这里插入图片描述][20191201203912818.png]  
`AopConfig`

@Aspect
    @Component
    @Order(2)
    @Slf4j
    public class AopConfig { 
    	private static final String POINT_CUT = "execution(* com.mybatis.service..*.*(..))";
    	//获取换行
    	private static final String SEPARATOR = System.getProperty("line.separator");
    
    	//aop拦截路径配置
    	@Pointcut(POINT_CUT)
    	private void pointcut(){ }
    
    	@Before(value = "pointcut()")
    	public void allBefore(JoinPoint joinPoint) { 
    		String className = joinPoint.getTarget().getClass().getName();
    		String methodName = joinPoint.getSignature().getName();
    		StringBuilder sb = new StringBuilder();
    		//日志打印
            sb.append(SEPARATOR)
    				.append("所属类方法:"+className)
    				.append("."+methodName)
    				.append(SEPARATOR)
    				.append("输入参数params:");
    		Object[] args = joinPoint.getArgs();
    		for (Object arg : args) { 
                sb.append(JSONObject.toJSONString(arg) + ", ");
    		}
    		log.info(sb.toString());
    	}
    
    	@AfterReturning(value = "pointcut()", returning = "returnObj")
    	public void afterReturn(Object returnObj) { 
    		StringBuilder sb = new StringBuilder();
    		sb.append(SEPARATOR);
    		if (returnObj != null) { 
    			 //TODO 处理不要打印所有日志
    			if (returnObj instanceof List) { 
    				List list = (List) returnObj;
    				sb.append("返回参数params数据条数: " + list.size());
    			} else { 
    				String result = JSONObject.toJSONString(returnObj);
    				sb.append("返回参数params: " + result);
    			}
    		}
            log.info(sb.toString());
    	}
    
    	@AfterThrowing(value ="pointcut()", throwing = "e")
    	public void afterThrowing(Throwable e) { 
            log.error(e.getMessage(), e);
    	}
    
    	@Around(value = "pointcut()")
    	public Object allAround(ProceedingJoinPoint joinPoint)throws Throwable { 
    		String className = joinPoint.getTarget().getClass().getName();
    		String methodName = joinPoint.getSignature().getName();
    
    		long begin = System.currentTimeMillis();
    		StringBuilder sb = new StringBuilder();
    		Object result = joinPoint.proceed();
    		long end =  System.currentTimeMillis();
    		sb.append(SEPARATOR)
    				.append("所属类方法:"+className)
    				.append("."+methodName)
    				.append(SEPARATOR)
    				.append("环绕通知: ")
    				.append("执行时间: ").append(end-begin).append("ms");
            log.info(sb.toString());
    		return result;
    	}
    }

`DataSourceConfig`

@Configuration
    @EnableTransactionManagement
    @MapperScan(basePackages = { "com.mybatis.dao"})
    public class DataSourceConfig { 
    
        @Bean
        @ConfigurationProperties(prefix = "spring.datasource.druid")
        public DataSource dataSource() { 
            DataSource dataSource = DruidDataSourceBuilder.create().build();
            return dataSource;
        }
    }

## 编写测试po，dao,mapper ##

![在这里插入图片描述][20191201204042415.png]  
`User`

@Data
    @NoArgsConstructor
    public class User { 
    
        private Integer id;
        private String iphone;
        private Integer password;
        private String name;
        private String sex;
    
    }

`UserDao`

public interface UserDao { 
    
        public List<User> getUser();
    }

`userMapper.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.mybatis.dao.UserDao" >
    
        
        <sql id="Base_Column_List" >
    	 id,iphone,password,name,sex
        </sql>
        
        <sql id="Example_Where_Clause">
            where 1=1
            <trim  suffixOverrides="," >
                <if test="user.id != null" >
                    and ID =  #{ user.id}
                </if>
                <if test="user.iphone != null and user.countryName != ''" >
                    and VERSION =  #{ countryPo.version}
                </if>
                <if test="user.password != null and user.countryName != ''" >
                    and COUNTRY_NAME =  #{ countryPo.countryName}
                </if>
                <if test="user.name != null and user.name != ''" >
                    and COUNTRY_CODE =  #{ countryPo.countryCode}
                </if>
                <if test="user.sex != null and user.sex != ''" >
                    and TWO_CODE =  #{ countryPo.twoCode}
                </if>
            </trim>
        </sql>
        
        <select id="getUser" resultType="User">
        select  <include refid="Base_Column_List"/> from sp_user
        </select>
    
    
    </mapper>

## 使用SpringBootTest测试 ##

![在这里插入图片描述][2019120120412922.png]  
`SpringbootTest`

@RunWith(SpringRunner.class)
    @SpringBootTest(classes = MybatisApplication.class)
    public class SpringbootTest { 
    
    
        @Autowired
        UserDao userDao;
    
    
        @Test
        public void getUserTest() { 
            List<User> users = userDao.getUser();
            users.forEach((user)-> System.out.println(user.getName()));
    
        }
    
    
        }

![在这里插入图片描述][20191201204513522.png]

## 完整项目测试 ##

新建 UserService、UserServiceImpl、UserController  
![在这里插入图片描述][20191201205025752.png]  
`UserService`

public interface UserService { 
    
        List<User> getUser();
    }

`UserServiceImpl`

@Service("userService")
    public class UserServiceImpl implements UserService { 
    
        @Autowired
        private UserDao userDao;
    
        @Override
        public List<User> getUser() { 
            return userDao.getUser();
        }
    }

`UserController`

@RestController
    public class UserController { 
        @Autowired
        UserService userService;
    
        @GetMapping("/getuser")
        public List<User> getUser() { 
            return userService.getUser();
        }
    
    }

`MybatisApplication`

@SpringBootApplication( scanBasePackages = {  "com.mybatis" })
    public class MybatisApplication { 
            SpringApplication.run(MybatisApplication.class, args);
        }
    
    }

启动`MybatisApplication`，访问 http://localhost:8088/aml/getuser  
![在这里插入图片描述][20191201205931961.png]

控制台输出：  
![在这里插入图片描述][201912012102436.png]

[20191201184602825.png]: https://img-blog.csdnimg.cn/20191201184602825.png
[20191201204653619.png]: https://img-blog.csdnimg.cn/20191201204653619.png
[20191201203912818.png]: https://img-blog.csdnimg.cn/20191201203912818.png
[20191201204042415.png]: https://img-blog.csdnimg.cn/20191201204042415.png
[2019120120412922.png]: https://img-blog.csdnimg.cn/2019120120412922.png
[20191201204513522.png]: https://img-blog.csdnimg.cn/20191201204513522.png
[20191201205025752.png]: https://img-blog.csdnimg.cn/20191201205025752.png
[20191201205931961.png]: https://img-blog.csdnimg.cn/20191201205931961.png
[201912012102436.png]: https://img-blog.csdnimg.cn/201912012102436.png