eclipse 使用maven 构建 springboot+mybatis

野性酷女 2023-10-17 11:33 125阅读 0赞

本文转载至：[http://www.cnblogs.com/java-zhao/p/5350021.html][http_www.cnblogs.com_java-zhao_p_5350021.html]

1、项目结构

![Center][]

2、pom.xml

<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">
    	<modelVersion>4.0.0</modelVersion>
    
    	<groupId>com.zzg</groupId>
    	<artifactId>springbootone</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<packaging>jar</packaging>
    
    	<name>springbootone</name>
    	<url>http://maven.apache.org</url>
    
    	<properties>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    	</properties>
    
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>1.4.3.RELEASE</version>
    	</parent>
    
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>junit</groupId>
    			<artifactId>junit</artifactId>
    			<version>3.8.1</version>
    			<scope>test</scope>
    		</dependency>
    		
    		<dependency>
               <groupId>io.springfox</groupId>
               <artifactId>springfox-swagger2</artifactId>
               <version>2.2.2</version>
            </dependency>
            <dependency>
               <groupId>io.springfox</groupId>
               <artifactId>springfox-swagger-ui</artifactId>
               <version>2.2.2</version>
            </dependency>
            
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-jdbc</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.0.14</version>
            </dependency>
            
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
            
            
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.2.8</version>
            </dependency>
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis-spring</artifactId>
                <version>1.2.2</version>
             </dependency>
    	</dependencies>
    </project>

说明：

*  spring-boot-starter-jdbc：引入与数据库操作相关的依赖，例如daoSupport等
 *  druid：阿里巴巴的数据源
 *  mysql-connector-java：mysql连接jar，scope为runtime
 *  mybatis + mybatis-spring：mybatis相关jar

3、application.properties

jdbc.driverClassName = com.mysql.jdbc.Driver
    jdbc.url = jdbc:mysql://127.0.0.1:3306/cms_website?zeroDateTimeBehavior=convertToNull&useUnicode=true&characterEncoding=utf-8
    jdbc.username = root
    jdbc.password = 123456
    
    mybatis.typeAliasesPackage=com.zzg.springbootone.domain  
    mybatis.mapperLocations=classpath:mapper/*.xml

说明：

*  mybatis.typeAliasesPackage：指定domain类的基包，即指定其在\*Mapper.xml文件中可以使用简名来代替全类名（看后边的UserMapper.xml介绍）
 *  mybatis.mapperLocations：指定\*Mapper.xml的位置

4、com.zzg.springbootone.common.MybatisConfig

作用：mybatis与springboot集成的入口

package com.zzg.springbootone.common;
    
    import java.util.Properties;
    
    import javax.sql.DataSource;
    
    import org.apache.ibatis.session.SqlSessionFactory;
    import org.mybatis.spring.SqlSessionFactoryBean;
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.core.env.Environment;
    import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
    
    import com.alibaba.druid.pool.DruidDataSourceFactory;
    
    /**
     * springboot集成mybatis的基本入口
     * 1）创建数据源
     * 2）创建SqlSessionFactory
     */
    @Configuration    //该注解类似于spring配置文件
    @MapperScan(basePackages="com.zzg.springbootone.mapper")
    public class MyBatisConfig {
        
        @Autowired
        private Environment env;
        
        /**
         * 创建数据源
         * @Primary 该注解表示在同一个接口有多个实现类可以注入的时候，默认选择哪一个，而不是让@autowire注解报错 
         */
        @Bean
        //@Primary
        public DataSource getDataSource() throws Exception{
            Properties props = new Properties();
            props.put("driverClassName", env.getProperty("jdbc.driverClassName"));
            props.put("url", env.getProperty("jdbc.url"));
            props.put("username", env.getProperty("jdbc.username"));
            props.put("password", env.getProperty("jdbc.password"));
            return DruidDataSourceFactory.createDataSource(props);
        }
    
        /**
         * 根据数据源创建SqlSessionFactory
         */
        @Bean
        public SqlSessionFactory sqlSessionFactory(DataSource ds) throws Exception{
            SqlSessionFactoryBean fb = new SqlSessionFactoryBean();
            fb.setDataSource(ds);//指定数据源(这个必须有，否则报错)
            //下边两句仅仅用于*.xml文件，如果整个持久层操作不需要使用到xml文件的话（只用注解就可以搞定），则不加
            fb.setTypeAliasesPackage(env.getProperty("mybatis.typeAliasesPackage"));//指定基包
            fb.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(env.getProperty("mybatis.mapperLocations")));//指定xml文件位置
            
            return fb.getObject();
        }
    
    }

说明：

*  类上边添加两个
    
     *  @Configuration注解（该注解类似于spring的配置文件）
     *  @MapperScan注解，指定扫描的mapper接口所在的包
 *  在该类中，注入了Environment实例，使用该实例可以去读取类路径下application.properties文件中的内容，读取文件内容的三种方式，见[第二章 第二个spring-boot程序][_spring-boot]
 *  在该类中，使用druid数据源定义了数据源Bean，spring-boot默认使用的是tomcat-jdbc数据源，这是springboot官方推荐的数据源（性能和并发性都很好）
 *  根据数据源生成SqlSessionFactory
    
     *  值得注意的是，数据源是必须指定的，否则springboot启动不了
     *  typeAliasesPackage和mapperLocations不是必须的，如果整个项目不需要用到\*Mapper.xml来写SQL的话（即只用注解就可以搞定），那么不需要配
 *  @Primary注解：指定在同一个接口有多个实现类可以注入的时候，默认选择哪一个，而不是让@Autowire注解报错（一般用于多数据源的情况下）

这样之后，在项目中再使用springboot就和在ssm中（配置完成后）使用一样了。

5、、com.zzg.springboot.mapper.UserMapper

package com.zzg.springbootone.mapper;
    
    import org.apache.ibatis.annotations.Insert;
    import org.apache.ibatis.annotations.Param;
    
    import com.zzg.springbootone.domain.User;
    
    public interface UserMapper {
    	@Insert("INSERT INTO tb_user(login_name, password) VALUES(#{loginName},#{password})")
        public int insertUser(@Param("loginName") String loginName, @Param("password")  String password);
    	
    	 /**
         * 插入用户，并将主键设置到user中
         * 注意：返回的是数据库影响条数，即1
         */
        public int insertUserWithBackId(User user);
    }

说明：该接口中有两个方法，

*  一个普通插入：直接用注解搞定
 *  一个插入返回主键：需要使用xml来搞定

6、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.zzg.springbootone.mapper.UserMapper">
        
        
        <insert id="insertUserWithBackId" parameterType="User" useGeneratedKeys="true" keyProperty="id" >
           <![CDATA[
           INSERT INTO tb_user 
           (
               login_name,
               password
           )
           VALUES
           (
               #{loginName, jdbcType=VARCHAR},
               #{password, jdbcType=VARCHAR}
           )
           ]]>
       </insert>
        
    </mapper>

7、com.zzg.springboot.dao.UserDao

package com.zzg.springbootone.dao;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Repository;
    
    import com.zzg.springbootone.domain.User;
    import com.zzg.springbootone.mapper.UserMapper;
    
    @Repository
    public class UserDao {
    	 	@Autowired
    	    private UserMapper userMapper;
    	    
    	    public int insertUser(String username, String password){
    	        return userMapper.insertUser(username, password);
    	    }
    	    
    	    public int insertUserWithBackId(User user){    
    	        return userMapper.insertUserWithBackId(user);
    	    }
    
    }

8、com.zzg.springboot.service.UserService

package com.zzg.springbootone.service;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    
    import com.zzg.springbootone.dao.UserDao;
    import com.zzg.springbootone.domain.User;
    
    @Service
    public class UserService {
    	@Autowired
        private UserDao userDao;
        
        public boolean addUser(String username, String password){
            return userDao.insertUser(username, password)==1?true:false;
        }
        
        public User addUserWithBackId(String loginname, String password){
            User user = new User();
            user.setLoginName(loginname);
            user.setPassword(password);
            userDao.insertUserWithBackId(user);//该方法后，主键已经设置到user中了
            return user;
        }
    }

9、com.zzg.springboot.controller.UserController

package com.zzg.springbootone.controller;
    
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiImplicitParam;
    import io.swagger.annotations.ApiImplicitParams;
    import io.swagger.annotations.ApiOperation;
    import io.swagger.annotations.ApiResponse;
    import io.swagger.annotations.ApiResponses;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.RequestHeader;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.RestController;
    
    import com.zzg.springbootone.domain.User;
    import com.zzg.springbootone.service.UserService;
    
    @RestController
    @RequestMapping("/user")
    @Api("userController相关api")
    public class UserController {
    	 	@Autowired
    	    private UserService userService;
    	    
    	    @ApiOperation("添加用户")
    	    @ApiImplicitParams({
    	        @ApiImplicitParam(paramType="query",name="loginname",dataType="String",required=true,value="用户的姓名",defaultValue="zhouzhigang"),
    	        @ApiImplicitParam(paramType="query",name="password",dataType="String",required=true,value="用户的密码",defaultValue="123456")
    	    })
    	    @ApiResponses({
    	        @ApiResponse(code=400,message="请求参数没填好"),
    	        @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
    	    })
    	    @RequestMapping(value="/addUser",method=RequestMethod.GET)
    	    public boolean addUser(@RequestParam("loginname") String loginname, 
    	                           @RequestParam("password") String password) {
    	        return userService.addUser(loginname,password);
    	    }
    	    
    	    @ApiOperation("添加用户且返回已经设置了主键的user实例")
    	    @ApiImplicitParams({
    	        @ApiImplicitParam(paramType="query",name="loginname",dataType="String",required=true,value="用户的姓名",defaultValue="zhouzhigang"),
    	        @ApiImplicitParam(paramType="query",name="password",dataType="String",required=true,value="用户的密码",defaultValue="123456")
    	    })
    	    @ApiResponses({
    	        @ApiResponse(code=400,message="请求参数没填好"),
    	        @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
    	    })
    	    @RequestMapping(value="/addUserWithBackId",method=RequestMethod.GET)
    	    public User addUserWithBackId(@RequestParam("loginname") String loginname, 
    	                                     @RequestParam("password") String password) {
    	        return userService.addUserWithBackId(loginname, password);
    	    }
    
    }

测试结果：

[http_www.cnblogs.com_java-zhao_p_5350021.html]: http://www.cnblogs.com/java-zhao/p/5350021.html
[Center]: https://img-blog.csdn.net/20170312015444142?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvemhvdXpoaXdlbmdhbmc=/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/Center
[_spring-boot]: http://www.cnblogs.com/java-zhao/p/5336369.html