相关推荐recommended
后端Springboot框架搭建APi接口开发(第一章)
作者:mmseoamin日期:2023-12-14

本文章以IDEA为开发工具,使用SSM框架进行项目编写

第一节:设计并创建数据库

我们用一个简单的用户表进行操作演示

首先创建Data数据库

create database data;

创建User数据表,表中包含用户邮箱,用户姓名,用户密码

create table user
(
	UserEamil varchar(50) not null primary key, 
	UserName varchar(50) not null,
    UserPWd varchar(50) not null
) engine innoDB default charset=utf8;

放点数据进去

insert into user value('admin123@qq.com','张三','admin123');
insert into user value('admin456@qq.com','李四','admin456');
insert into user value('admin789@qq.com','王五','admin789');

第二节:创建简易的SpringBoot项目

打开IDEA,在右上角点击NewProject。创建新的项目

后端Springboot框架搭建APi接口开发(第一章),image-20230323164020979,第1张

选择Spring Initializr框架,依次输入项目名称、项目路径、类型、组名、java版本。最后选择Next下一步。(为了统一性,建议与下图保持一致)

后端Springboot框架搭建APi接口开发(第一章),image-20230323164306902,第2张

这一步是要选择你项目中所需要的依赖。但是我这里要在配置文件中手动添加,因此直接点击右下角的create,完成创建。

后端Springboot框架搭建APi接口开发(第一章),image-20230323164818450,第3张

第三节:配置IDEA Database文件

在IDEA对话框的右上角找到竖着写的Database

后端Springboot框架搭建APi接口开发(第一章),image-20230322143255319,第4张

根据图文提示创建新的mysql数据库连接

后端Springboot框架搭建APi接口开发(第一章),image-20230322143324409,第5张

根据图文填写信息

后端Springboot框架搭建APi接口开发(第一章),image-20230322143750589,第6张

第四节:配置Pom.xml文件

pom.xml文件是maven的核心配置文件,主要用于导入maven依赖已经maven常规配置

注意:强烈不建议任何xml配置文件代码中存在中文注释

第一小节:导入maven依赖

Springboot API接口开发需要Mysql、MyBatis、junit、lombok、Springboot、SpringWeb依赖

查找maven的依赖可以在:maven官方网站查询(需要科x上网)

在项目结构最顶端找到pom.xml文件

后端Springboot框架搭建APi接口开发(第一章),image-20230323165250383,第7张

可以看到pom.xml文件中只有一些基本的配置信息,和一个Stringboot依赖

后端Springboot框架搭建APi接口开发(第一章),image-20230323165319721,第8张

可以复制我的依赖配置信息到pom.xml文件中


            org.springframework.boot
            spring-boot-starter
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
        
        
            org.mybatis
            mybatis
            3.5.9
        
        
        
            mysql
            mysql-connector-java
            8.0.32
        
        
        
            junit
            junit
            4.13
            test
        
        
        
            org.junit.jupiter
            junit-jupiter-api
            5.9.2
            test
        
        
        
            org.projectlombok
            lombok
            1.18.24
            provided
        
		
		
    		org.springframework.boot
   			spring-boot-starter-web
   			2.6.14
		

第二小节:maven静态资源导出问题

静态资源导出,,不管是java文件下还是resources文件下,都导出


            
                src/main/java
                
                    **/*.xml
                
                true
            
            
                src/main/resources
                
                    **/*.yml
                    **/*.properties
                    **/*.xml
                    
                    **/*.setting
                
                false
            
        

第三小节:刷新maven配置文件

一、二小节的配置完成后,点击一些右上角带M的小图标就可以了

后端Springboot框架搭建APi接口开发(第一章),image-20230322142707897,第9张

如果没有那个小图标,可以点击右侧的Maven里面的Install

后端Springboot框架搭建APi接口开发(第一章),image-20230323165635281,第10张

这里是完整的pom.xml配置代码

文件路径:SpringBoot\pom.xml



    4.0.0
    com.example
    demo
    0.0.1-SNAPSHOT
    demo
    demo
    
        1.8
        UTF-8
        UTF-8
        2.6.11
    
    
        
            org.springframework.boot
            spring-boot-starter
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
        
        
            org.mybatis
            mybatis
            3.5.9
        
        
        
            mysql
            mysql-connector-java
            8.0.32
        
        
        
            junit
            junit
            4.13
            test
        
        
        
            org.junit.jupiter
            junit-jupiter-api
            5.9.2
            test
        
        
        
            org.projectlombok
            lombok
            1.18.24
            provided
        
        
        
            org.springframework.boot
            spring-boot-starter-web
            2.6.14
        
    
    
        
            
                org.springframework.boot
                spring-boot-dependencies
                ${spring-boot.version}
                pom
                import
            
        
    
    
        
            
                org.apache.maven.plugins
                maven-compiler-plugin
                3.8.1
                
                    1.8
                    1.8
                    UTF-8
                
            
            
                org.springframework.boot
                spring-boot-maven-plugin
                ${spring-boot.version}
                
                    com.example.demo.DemoApplication
                    true
                
                
                    
                        repackage
                        
                            repackage
                        
                    
                
            
        
        
            
                src/main/java
                
                    **/*.xml
                
                true
            
            
                src/main/resources
                
                    **/*.yml
                    **/*.properties
                    **/*.xml
                    
                    **/*.setting
                
                false
            
        
    

第五节:配置Mysql配置文件

在目录结构中创建一个resource文件夹,并在文件夹下创建一个Mybatis-config.xml文件

后端Springboot框架搭建APi接口开发(第一章),image-20230323165858347,第11张

注意配置driver、url、username、password等信息

文件路径:SpringBoot\src\main\resources\Mybatis-config.xml




    
        
            
            
                
                
                
                
            
        
    





第六节:创建基础文件结构

按照图文所示,在main文件目录下依次创建java->com->zzj->demo,又在demo目录下创建controller、entity、mapper、util文件夹

文件夹名称文件夹中文名文件夹说明
controllerapi接口类用于编写api接口方法
entity实体类用于编写与数据库字段的实体类方法,要求必须与数据库的字段相同
mappermapper方法类用于编写mybatis操作数据库的执行方法
util工具类用于编写会在程序中多次调用的方法,并封装起来供多次调用

后端Springboot框架搭建APi接口开发(第一章),image-20230323170528033,第12张

第七节:mybatis基础框架搭建

第一小节:编写实体类

在entity文件夹中创建User.java(文件名最好与数据表表命保持一致)

后端Springboot框架搭建APi接口开发(第一章),image-20230322152640202,第13张

这里用lombok注解的方式创建实体类

文件路径:demo\src\main\java\com\zzj\demo\entity\user.java

package com.zzj.demo.entity;
import lombok.*;
@Getter //Get方法
@Setter //Set方法
@ToString //ToString方法
@AllArgsConstructor //有产
@NoArgsConstructor //无产
public class user {
    private String UserEamil;
    private String UserName;
    private String UserPwd;
}

第二小节:编写mapper方法

这里以查询全部用户信息为例

在mapper文件夹中创建usermapper.java(注意:这里的usermapper.java需要创建interface)以及usermapper.xml两个文件

后端Springboot框架搭建APi接口开发(第一章),image-20230323171054912,第14张

UserMapper.java

文件路径:demo\src\main\java\com\zzj\demo\mapper\UserMapper.java

package com.zzj.demo.mapper;
import com.zzj.demo.entity.user;
import java.util.List;
public interface UserMapper {
    List seleteUserList();
}
UserMapper.xml

文件路径:demo\src\main\java\com\zzj\demo\mapper\UserMapper.xml




    

找到刚才创建的pom.xml核心配置文件文件,找到注释的代码,并取消注释

这里的mappers因mapper还没有开始编写,先暂时注释掉

文件路径:SpringBoot\src\main\resources\Mybatis-config.xml




    
        
            
            
                
                
                
                
            
        
    
    
        
            
        

第三小节:编写测试类

到这里Mybatis的基本框架就算是搭建完成了,但是还需要在测试类运行一些。看看是否可以获取信息

src创建一个新的Test文件夹,并且创建一个与上面相同的文件夹结构

并且在文件夹最底层创建一个mapperTest.java测试类文件

后端Springboot框架搭建APi接口开发(第一章),image-20230322172456202,第15张

文件路径:SpringBoot\src\test\java\com\zzj\UserMapperTest.java

package com.zzj;
import com.zzj.entity.User;
import com.zzj.mapper.UserMapper;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Test;
import java.io.IOException;
import java.io.InputStream;
public class UserMapperTest {
    @Test
    public void TestDemo01() throws IOException {
        //获取Mybatis配置文件
        String resource = "Mybatis-config.xml";
//        构建SqlSessionFactory
        InputStream resourceAsStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory build = new SqlSessionFactoryBuilder().build(resourceAsStream);
        SqlSession sqlSession = build.openSession();
//        调用映射器接口
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
//        遍历数据,并打印
        for (User user : mapper.seleteUserList()) {
            System.out.println(user);
        }
//        记得一点要关闭SqlSession,否者会导致Mysql连接数过高,无法访问
        sqlSession.close();
    }
}

第四小节:运行测试类

点击下图的绿色小图标就可以运行测试类

后端Springboot框架搭建APi接口开发(第一章),image-20230323155710917,第16张

在下面的控制台可以看见结果已经输出了

后端Springboot框架搭建APi接口开发(第一章),image-20230323160410246,第17张

到这里Mybatis数据库查询操作就已经完成了。但是还没有实现利用APi接口进行数据库访问的功能,具体会在下节讲解。