搭建SpringBoot项目

最新推荐文章于 2024-07-12 12:08:23 发布

陈厚伯

最新推荐文章于 2024-07-12 12:08:23 发布

阅读量526

点赞数

分类专栏： java mybatis springboot 文章标签： spring boot mysql java

本文链接：https://blog.csdn.net/qq_41107680/article/details/110111059

版权

java 同时被 3 个专栏收录

9 篇文章 0 订阅

订阅专栏

mybatis

2 篇文章 0 订阅

订阅专栏

springboot

2 篇文章 0 订阅

订阅专栏

使用IDEA搭建SpringBoot项目

1.创建项目

在这里插入图片描述

1.1

完善项目信息，填写组名，项目名，java版本；最后src->main->java下包名会是：com->example->fighting；点击next
在这里插入图片描述

1.2

勾选一下这些选项，点击next
在这里插入图片描述

1.3

选择项目路径点击Finish
在这里插入图片描述

1.4

配置maven仓库
在这里插入图片描述

1.5

新建一个index.html页面，作为启动后的初始页面
在这里插入图片描述

1.6

com.example.fighting下新建controller文件夹，在文件加下新建一个helloController类。Controller类要添加@Controller注解，项目启动时，SpringBoot会自动扫描加载Controller 在这里插入图片描述

1.7

在resources文件夹下application中先配置DataSource基本信息，application文件有两种文件格式，一种是以.properties为后缀，一种是以.yml为后缀的，两种配置方式略有差别，详情可参考这个网址：https://blog.csdn.net/qq_29648651/article/details/78503853

#端口名
server.port=8014
#数据库名
spring.datasource.name=chenhb
#url
spring.datasource.url=jdbc:mysql://localhost:3306/chenhb
#用户名
spring.datasource.username=rootsss
#密码
spring.datasource.password=123456
#数据库链接驱动
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

运行项目启动类FightingApplication.java
在这里插入图片描述
启动日志

1.8

可以发现上面有一个WARN警告，那是因为还没有配置编写MyBatis的相关文件。
到这初步搭建已经完成；

在这里插入图片描述

2.连接数据库

2.1

点击右侧的Database，点“加号”，新建数据库连接
在这里插入图片描述

2.2

输入数据库信息
在这里插入图片描述

2.3

如果测试连接失败，就点击左上角扳手，然后更换数据库设置。在这里插入图片描述

3.项目基础设置

3.1

springboot项目大致可分为四层
（1）DAO层：包括XxxMapper.java(数据库访问接口类)，XxxMapper.xml(数据库连接实现)；
（2）Bean层：也叫model层、模型层、entity层、实体层，就是数据库表的映射实体类，存放POJO对象；
（3）Service层：也叫服务层，业务逻辑层，包括XxxService.java(业务接口类)，XxxServiceImpl.java（业务实现类）；
（4）Web层：就是Controller层，实现与web前端的交互，给前端提供接口等。

3.2

大致目录如下所示：
在这里插入图片描述

3.3

在配置文件application中添加mybatis配置

#配置实体类
mybatis.type-aliases-package=com.example.test.bean
#配置映射文件
mybatis.mapper-locations=classpath:/mapper/**/*.xml

3.4

pom.xml文件配置信息

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.1-SNAPSHOT</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>fighting</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>fighting</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!--jdbc配置-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <!--thymeleaf模板引擎配置-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <!--Web依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--MyBatis配置-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.4</version>
        </dependency>
        <!--MySQL数据库配置-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <!--单元测试配置-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
        </repository>
        <repository>
            <id>spring-snapshots</id>
            <name>Spring Snapshots</name>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
        </pluginRepository>
        <pluginRepository>
            <id>spring-snapshots</id>
            <name>Spring Snapshots</name>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </pluginRepository>
    </pluginRepositories>
</project>

3.5

自动生成bean类、实体类，插入文件generatorConfig.xml，代码如下
具体的参考文件配置，可以参考这个:https://www.cnblogs.com/f-society/p/11402847.html

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<!-- mybatis-generator的核心配置文件 -->
<generatorConfiguration>
    <classPathEntry location="D:\idea\chenhbTest\maven\repository\mysql\mysql-connector-java\8.0.22\mysql-connector-java-8.0.22.jar" />

    <context id="DB2Tables" targetRuntime="MyBatis3">
        <!--自己的远程或者本地的mysql服务器-->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://127.0.0.1:3306/chenhb?serverTimezone=Asia/Shanghai"
                        userId="root"
                        password="root">
            <property name="useInformationSchema" value="true"/>
        </jdbcConnection>
        <!--指定生成的类型为java类型，避免数据库中number等类型字段 -->
        <javaTypeResolver >
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!--自动生成的实体的存放包路径 -->
        <javaModelGenerator targetPackage="com.example.fighting.bean" targetProject="./src/main/java">
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!--自动生成的*Mapper.xml文件存放路径 -->
        <sqlMapGenerator targetPackage="mapper"  targetProject="./src/main/resources">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <!--自动生成的*Mapper.java存放路径 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.fighting.mapper"  targetProject="./src/main/java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>

        <!-- 映射配置 -->
        <table tableName="informationtest" domainObjectName="UserTest" ></table>
    </context>
</generatorConfiguration>

3.6

在pom文件中添加插件

<plugin>
     <groupId>org.mybatis.generator</groupId>
     <artifactId>mybatis-generator-maven-plugin</artifactId>
     <version>1.3.5</version>
</plugin>

为方便开发和接口测试，我这里引入了swagger依赖、

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.6.1</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.6.1</version>
</dependency>

3.7

打开命令窗口，执行generatorConfig.xml文件

mvn -Dmybatis.generator.overwrite=true mybatis-generator:generate

在这里插入图片描述
目录结构如下：

3.8 bean实体类如下所示

已自动生产get和set方法
在这里插入图片描述

3.9 dao层访问数据库接口文件（Mapper）如下所示

包含了简单的增删改查，后期可自己自定义添加
在这里插入图片描述

3.10 dao层访问数据库xml文件如下所示

自动映射相应字段属性
在这里插入图片描述
注意： 注意标签的namespace属性要填写访问数据库接口类文件路径

3.11 Service层业务接口类

package com.example.fighting.service;

import com.example.fighting.bean.UserTest;

public interface UserTestService {

    UserTest getUserTest(String name);

}

3.12 Service层业务实现类

注意要注解@Service，注入DAO

package com.example.fighting.serviceImpl;

import com.example.fighting.bean.UserTest;
import com.example.fighting.bean.UserTestExample;
import com.example.fighting.mapper.UserTestMapper;
import com.example.fighting.service.UserTestService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserTestServiceImpl implements UserTestService {

    //将DAO注入Service层
    @Autowired
    private UserTestMapper userTestMapper;

    @Override
    public UserTest getUserTest(String name) {
	        UserTestExample userTestExample = new UserTestExample();
	        UserTestExample.Criteria criteria = userTestExample.createCriteria().andNameEqualTo(name);
	        List<UserTest> list = userTestMapper.selectByExample(userTestExample);
	        return list.get(0);
	}
}

3.13 启动类添加注解，不然启动的时候报找不到mapper类

在这里插入图片描述

3.14 Controller层

package com.example.fighting.controller;

import com.example.fighting.bean.UserTest;
import com.example.fighting.service.UserTestService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
@RequestMapping("/userTest")
public class UserTestController {
    //将Service注入Web层
    @Autowired
    UserTestService userTestService;

    @RequestMapping("/login")
    public String show(){
        return "login";
    }

    @RequestMapping(value = "/getUserTest",method = RequestMethod.GET)
    public String login(String name){
        System.out.println("getUserTest-name:"+ name);
        UserTest userBean = userTestService.getUserTest(name);
        System.out.println("userBean-id:"+ userBean.getId());
        if(userBean!=null){
            return "success";
        }else {
            return "error";
        }
    }

}

准备的文件,在index.html文件同级下
在这里插入图片描述

error.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>fighting----chenhb</title>
</head>
<body>
    子白，你真笨！
</body>
</html>

success.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>fighting----chenhb</title>
</head>
<body>
    子白，你真聪明！
</body>
</html>

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>fighting----login</title>
</head>
<body>
<form role="form" action = "/userTest/getUserTest" method="get">
    姓名：<input type="text" id="name" name = "name"> <br>
    <input type="submit" id = "login" value = "login">
</form>
</body>
</html>

3.15 测试

在这里插入图片描述

数据库信息

4. Swagger接口测试配置

4.1 创建Swagger2配置类

1.建一个config包com.example.fighting.config

2.在config下新建Swagger2类，代码如下：

package com.example.fighting.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.fighting.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                .description("更多Spring Boot相关文章请关注：https://blog.csdn.net/qq_41107680/")
                .termsOfServiceUrl("https://blog.csdn.net/qq_41107680")
                .contact("程序猿DD")
                .version("1.0")
                .build();
    }
}

如上代码所示，通过@Configuration注解，让Spring来加载该类配置。再通过@EnableSwagger2注解来启用Swagger2.
再通过createRestApi函数创建Docket的Bean之后，apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）

4.2 添加文档内容

在controller中使用注解
@ApiOperation注解来给API增加说明
@ApiImplicitParams、@ApiImplicitParam注解来给参数增加说明
接口如下所示：

 @ApiOperation(value="获取用户",notes ="根据用户名得到一个用户信息")
    @ApiImplicitParam(paramType="query",name="names",value="用户姓名",required = true)
    @RequestMapping(value = "/getUserTest2",method = RequestMethod.GET)
    public UserTest getUserTest2(String names){
        System.out.println("getUserTest2-name:"+ names);
        UserTest userBean = userTestService.getUserTest(names);
        System.out.println("userBean-id:"+ userBean.getId());
        if(userBean!=null){
            return userBean;
        }else {
            return null;
        }
    }

4.3 测试

在浏览器中输入：http://localhost:8014/swagger-ui.html#/
在这里插入图片描述
这个是我们增加的接口：

输入用户姓名，点击Try it out

测试结果如下：

至此，整个项目后台的基础框架算是搭起来了。此篇博客仅供学习参考！欢迎大家一起提问学习，谢谢！

陈厚伯

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
搭建SpringBoot项目

使用IDEA搭建SpringBoot项目1.创建项目1.完善项目信息，填写组名，项目名，java版本；最后src->main->java下包名会是：com->example->fighting；点击next2.勾选一下这些选项，点击next3.选择项目路径点击Finish4.配置maven仓库5.新建一个index.html页面，作为启动后的初始页面6.com.example.fighting下新建controller文件夹，在文件加下新建一个hell
复制链接

扫一扫

专栏目录