【实践1】使用IDEA创建 springboot + mybtis + mysql 小demo 项目全过程

最新推荐文章于 2023-05-12 20:41:27 发布

紫薯真好吃

最新推荐文章于 2023-05-12 20:41:27 发布

阅读量896

点赞数

分类专栏： spring 文章标签：后台项目 spring mysql mybatis

原文链接：https://blog.csdn.net/steven_zhulin/article/details/90726347

版权

spring 专栏收录该内容

5 篇文章 1 订阅

订阅专栏

这篇博客记录创建一个可运行的springboot+mybatis项目的全过程，参考博客：https://blog.csdn.net/steven_zhulin/article/details/90726347

可以成功运行的项目完整代码：https://github.com/WQAQs/demoproject.git

步骤如下：

1. 创建项目

（1.打开IDEA

（2.File ==> new ==> project ,如图：

（3.选择spring Initializr ==> 右边的Project SDK我选的是我已经安装的1.8版本,其他默认 ==> 点击next

（4.填写Group （自己随意就行，我的是cn + 个人英文名 + study） ==> 填写 Artifact （也是自己随意就行，这个也是你的项目名） ==> 点击next ，如图：

（5.选择项目所需依赖（由于项目是springboot+mybatis的Java后台项目，因此需要勾上三个依赖） ==> 点击next ，如图：

（6.选择项目路径 ==> 点击finish ,如图：

（6.最终生成的项目代码目录如图（resources目录下的static和templates目录无用，可以删掉）：

（注：如果DemoprojectApplication类(即启动类)的图标显示是 J 而不是 C ，则说名该项目还没有被初始化为maven项目，解决方法见后面）

至此，springboot项目搭建完成一半，还需要做mybatis的配置，如下：

2.数据库和mybatis的配置

2.1 在application.properties填入数据库连接参数和mybatis配置信息

application.properties内容如下：

#1.项目启动的端口
server.port=18902
 
#2.数据库连接参数
#2.1jdbc驱动，示数据库厂商决定，这是mysql的驱动
jdbc.driver=com.mysql.cj.jdbc.Driver


#2.2数据库连接url，包括ip(127.0.0.1)、端口(3306)、数据库名(testdb)
jdbc.url=jdbc:mysql://127.0.0.1:3306/testdb?useUnicode=true&characterEncoding=utf-8&useSSL=false
#2.3数据库账号名
jdbc.username=root
#2.4数据库密码
jdbc.password=123
 
#3.Mybatis配置
#3.1 mybatis配置文件所在路径
mybatis_config_file=mybatis-config.xml
#3.2 mapper文件所在路径，这样写可匹配mapper目录下的所有mapper，包括其子目录下的
mapper_path=/mapper/**/**.xml
#3.3 entity所在包
entity_package=cn.stephen.study.demoproject.entity

注意：2.2～2.4的设置信息要与两处地方保持一致：（1）docker创建mysql容器；（2）IDEA连接mysql服务器！！！

示例如图：

2.2 在resources目录下新建 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>
        <!--使用jdbc的getGeneratedKeys获取数据库自增主键值-->
        <setting name="useGeneratedKeys" value="true"/>
        <!--使用列标签替换列别名 默认未true-->
        <setting name="useColumnLabel" value="true" />
        <!--开启驼峰式命名转换：Table{create_time} -> Entity{createTime}-->
        <setting name="mapUnderscoreToCamelCase" value="true" />
    </settings>
</configuration>

效果如图：

2.3 创建config配置类，使用Spring的注释装配

配置类使用Spring的注释装配，共三个配置类：DataSourceConfiguration类、SessionFactoryConfiguration类、TransactionManagementConfiguration类

其中DataSourceConfiguration类、SessionFactoryConfiguration类属于dao层数据库访问与持久化的配置，TransactionManagementConfiguration类属于service层的配置。

配置类结构如图：

2.3.1 DataSourceConfiguration类的代码如下：

package cn.stephen.study.demoproject.config.dao;
 
import com.mchange.v2.c3p0.ComboPooledDataSource;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
import java.beans.PropertyVetoException;
 
/**
 * 数据库配置类
 */
@Configuration
public class DataSourceConfiguration {
 
    @Value("${jdbc.driver}")
    private String jdbcDriver;
    @Value("${jdbc.url}")
    private String jdbcUrl;
    @Value("${jdbc.username}")
    private String jdbcUsername;
    @Value("${jdbc.password}")
    private String jdbcPassword;
 
    @Bean(name = "dataSouce")
    public ComboPooledDataSource createDataSouce() throws PropertyVetoException {
        ComboPooledDataSource dataSource = new ComboPooledDataSource();
        dataSource.setDriverClass(jdbcDriver);
        dataSource.setJdbcUrl(jdbcUrl);
        dataSource.setUser(jdbcUsername);
        dataSource.setPassword(jdbcPassword);
        //关闭连接后不自动commit
        dataSource.setAutoCommitOnClose(false);
        return dataSource;
    }
}

2.3.2 SessionFactoryConfiguration类的代码如下：

package cn.stephen.study.demoproject.config.dao;
 
import org.mybatis.spring.SqlSessionFactoryBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
 
import javax.sql.DataSource;
import java.io.IOException;
 
/**
 * 数据库sqlSession配置类
   重点： mybatis操作sql的相关配置
 */
 
@Configuration
public class SessionFactoryConfiguration {
 
    @Value("${mapper_path}")
    private String mapperPath;
 
    @Value("${mybatis_config_file}")
    private String mybatisConfigFilePath;
 
    @Autowired
    private DataSource dataSouce;
    @Value("${entity_package}")
    private String entityPackage;
 
    @Bean(name="sqlSessionFactory")
    public SqlSessionFactoryBean createSqlSessionFactoryBean() throws IOException {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setConfigLocation(new ClassPathResource(mybatisConfigFilePath));
        PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        String packageSearchPath = PathMatchingResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX+mapperPath;
        sqlSessionFactoryBean.setMapperLocations(resolver.getResources(packageSearchPath));
        sqlSessionFactoryBean.setDataSource(dataSouce);
        sqlSessionFactoryBean.setTypeAliasesPackage(entityPackage);
        return sqlSessionFactoryBean;
    }
}

2.3.3 TransactionManagementConfiguration类的代码如下：

package cn.stephen.study.demoproject.config.service;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.annotation.EnableTransactionManagement;
import org.springframework.transaction.annotation.TransactionManagementConfigurer;
 
import javax.sql.DataSource;
 
/**
 * 事务配置类，不可缺少，尚未知具体作用
 */
@Configuration
@EnableTransactionManagement
public class TransactionManagementConfiguration implements TransactionManagementConfigurer{
 
    @Autowired
    private DataSource dataSource;
 
    @Override
    public PlatformTransactionManager annotationDrivenTransactionManager() {
        return new DataSourceTransactionManager(dataSource);
    }
}

三个类的代码写完后，在DataSourceConfiguration类中会报找不到某些类的错，在下一步解决。

2.4 在 pom.xml文件的<dependencies></dependencies>插入以下两个依赖

<!--线程池-->
<dependency>
    <groupId>com.mchange</groupId>
    <artifactId>c3p0</artifactId>
    <version>0.9.5.2</version>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

至此，项目配置已完成

3. 项目功能开发

3.1项目结构

就按最普遍的分层代码目录结构来写一个基本的测试来测试项目是否能正常运行。一共需要新建4个包（controller、service、dao、entity）和一个目录（mapper），具体代码目录结果如图：

Controller层（action层）：控制层——控制业务逻辑

Controller层负责具体的业务模块流程的控制，controller层主要调用Service层里面的接口控制具体的业务流程，控制的配置也需要在配置文件中进行。

service：业务层——控制业务

Service层主要负责业务模块的逻辑应用设计。和DAO层一样都是先设计接口，再创建要实现的类，然后在配置文件中进行配置其实现的关联。接下来就可以在service层调用接口进行业务逻辑应用的处理。
封装Service层的业务逻辑有利于业务逻辑的独立性和重复利用性。

dao：持久层——主要与数据库进行交互

DAO层主要是做数据持久层的工作，主要与数据库进行交互。DAO层首先会创建DAO接口，然后会在配置文件中定义该接口的实现类，接着就可以在模块中就可以调用DAO 的接口进行数据业务的而处理，并且不用关注此接口的具体实现类是哪一个类。DAO 层的数据源和数据库连接的参数数都是在配置文件中进行配置的。

entity：实体层——数据库在项目中的类

# Conroller层和Service层的区别：Controlle层负责具体的业务模块流程的控制；Service层负责业务模块的逻辑应用设计；

# View层：此层与控制层结合比较紧密，需要二者结合起来协同工发，View层主要负责前台jsp页面的表示。（本项目没用到）

3.2 controller包放控制层代码，TestController类的代码如下：

package cn.stephen.study.demoproject.controller;
 
 
import cn.stephen.study.demoproject.entity.TestEntity;
import cn.stephen.study.demoproject.service.TestService;
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.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
@RequestMapping("/demoproject/test")
public class TestController {
 
    @Autowired
    private TestService testService ;
 
    @RequestMapping(value = "/get/{id}",method = RequestMethod.GET)
    public TestEntity test(@PathVariable Integer id){
        System.out.println("id:" + id);
        return testService.getById(id);
    }
 
}

3.3 service层放业务处理层代码，TestService类的代码如下：

package cn.stephen.study.demoproject.service;
 
import cn.stephen.study.demoproject.dao.TestDao;
import cn.stephen.study.demoproject.entity.TestEntity;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
 
@Service
public class TestService {
 
    @Autowired
    private TestDao testDao ;
 
    public TestEntity getById(Integer id){
        return testDao.getById(id);
    }
}

3.4 dao包放数据存取层代码，TestDao代码如下：

package cn.stephen.study.demoproject.dao;
 
import cn.stephen.study.demoproject.entity.TestEntity;
import org.apache.ibatis.annotations.Mapper;
 
@Mapper
public interface TestDao {
 
    TestEntity getById(Integer id);
 
}

`3.5 entity包放数据库表对应的实体类，TestEntity实体类代码如下：`

package cn.stephen.study.demoproject.entity;
 
public class TestEntity {
 
    protected Integer id ;
 
    protected String magicId ;
 
    protected String firstName ;
 
    protected String lastName ;
 
    public Integer getId() {
        return id;
    }
 
    public void setId(Integer id) {
        this.id = id;
    }
 
    public String getMagicId() {
        return magicId;
    }
 
    public void setMagicId(String magicId) {
        this.magicId = magicId;
    }
 
    public String getFirstName() {
        return firstName;
    }
 
    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }
 
    public String getLastName() {
        return lastName;
    }
 
    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
}

3.6 mapper目录放dao层代码的具体实现

这是mybatis的特色，用xml文件来实现数据存取，TestDaoMapper的内容如下：

<?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="cn.stephen.study.demoproject.dao.TestDao">
    <!-- 根据主键查询-->
    <select id="getById" resultType="cn.stephen.study.demoproject.entity.TestEntity" parameterType="java.lang.Integer" >
        select  *
        from test
        where id = #{id}
    </select>
</mapper>

4 测试项目

4.1 准备数据库资源

（1）docker建立和启动mysql容器

打开terminal输入指令：

docker run --name learn-mysql \
    -v learn-vol:/var/lib/mysql \
        -p 3306:3306 \
        -e MYSQL_ROOT_PASSWORD=123 \
        -d mysql

指令说明：

--name ： 定义一个容器的名字，如果在执行docker run时没有指定Name，那么deamon会自动生成一个随机数字符串当做UUID。
-v：用来挂载数据目录、配置文件、日志等，这样重启实例后数据不会丢失
-p 标识通知 Docker 将容器内部使用的网络端口映射到我们使用的主机上。
-e 设置环境变量，或者覆盖已存在的环境变量。
-d 标识是让 docker 容器在后台运行。-d mysql 即为在后台运行并显示说明标志：mysql

（如果已经建立过一个mysql容器，就直接启动就行，否则新建一个容器并启动）

其他常用指令：


docker start con_name 启动容器名为con_name的容器。

docker stop con_name 停止容器名为con_name的容器。

docker rm con_name 删除容器名为con_name的容器。

docker rename old_name new_name 重命名一个容器。

（2）IDEA连接mysql数据库服务器

点击右边栏的Database选项卡，在弹出的窗口选择➕，在弹出的下拉列表中选择DataSource为MySQL：

接着输入账户和密码（其他配置信息是默认自动填入的）：

配置信息与前面两处保持一致：2.1中的jdbc相关配置； 4.1（1）建立mysql容器的相关配置。

即这里的账户： root，密码：123（如果在创建mysql容器时已经顺便建立了一个数据库testdb，则填写Database：testdb）

（经过几次连接数据库服务器又删除重连发现，第一次连接不用写Database：testdb（因为那个时候服务器上还没有该数据库），但是之后再建立连接需要填写Database：testdb，不然会显示不出来testdb数据库）

apply之后，显示已经连上服务器：

（3）建立数据库脚本文件

新建一个testdb1.sql脚本文件，在之后连接上mysql数据库服务器后运行，即可建立相应的数据库并插入数据。脚本代码：

CREATE database testdb

use testdb
CREATE TABLE `test` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `magic_id` varchar(32) NOT NULL,
  `first_name` varchar(32) NOT NULL,
  `last_name` varchar(32) NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=utf8;

INSERT INTO test ( id, magic_id, first_name, last_name) VALUES ( 6, 66, "miao", "m");

选择在连接的服务器上运行sql：

执行所有选中的sql语句：

运行之后，可以看到服务器上新建了testdb数据库，在testdb中新建了表test，并在表中插入了内容：

注意：如果mysql服务器上已经存在testdb数据库和test表，就不能重复创建。数据库是在mysql服务器上，IDEA里面只是连接和操作本地的服务器，之前存在的数据，直接访问即可。（也就是说，上述的sql脚本只用运行一遍！之后直接连接服务器，直接访问即可。想更改数据再运行别的sql语句）

4.2 postman测试项目效果

测试代码写完，就可以打开postman软件去做测试了。

（注：在官网上下载postman软件，不要使用在线网页版测试，否则可能出现问题）

打开DemoprojectApplication，运行demo项目：

打开postman，输入get并send ，测试结果如图：

请求链接：http://127.0.0.1:18902/demoproject/test/get/6

5. 遇到的问题

（1. DemoprojectApplication类(即启动类)的图标显示是 J 而不是 C ，则说名该项目还没有被初始化为maven项目

解决：

简单配置一下就可以用idea绿色启动按钮了,英语不好,附上了个中文版的,英文版的同学,对照设置的位置即可找到设置.
在这里插入图片描述

（2. java: 程序包org.springframework.boot不存在

在IDEA中新建SpringBoot项目，后启动项目时提示：

Error:(3, 32) java: 程序包org.springframework.boot不存在

解决：

将pom.xml中parent依赖版本降低，这里改为2.1.6,然后在右边Maven面板中点击Reimport All Maven Projects

紫薯真好吃

关注

0
点赞
踩
6

收藏

觉得还不错? 一键收藏
0
评论
【实践1】使用IDEA创建 springboot + mybtis + mysql 小demo 项目全过程

鉴于隔很久再在IDEA新建springboot项目时，会出现对步骤不确定的情况，因此，写下这篇博客记录创建一个可运行的springboot+mybatis项目的全过程。步骤如下：1. 创建项目（1.打开IDEA（2.File ==> new ==> project ,如图：（3.选择spring Initializr ==> 右边的Project SDK我选的是我已经安装的1.8版本,其他默认 ==> 点击next（4.填写Group （自己...
复制链接

扫一扫