掘金 后端 ( ) • 2024-04-01 14:10
后端开发框架Spring Boot快速入门
后端 框架

IDEA创建Spring Boot工程

关于Spring Boot框架项目，IDEA为我们提供了比较快捷的创建方式，如下:

  1. 点击新建项目，左边一栏选择Spring Initializr,右边一栏配置项目相关属性，如下图: 捕获37.PNG

项目工程名，项目工程存储地址自定义，项目工程类型Type选择Maven,语言Language选择Java,后面三项建议不要改，直接默认即可，项目工程的软件开发工具包project SDK选择你自己安装的java JDK版本(我安装的是JDK 17)，字段java 选择你自己安装的java JDK版本号，我这里选择的是17,包类型 Packaging选择Jar。

2.点击Next后，选择该工程需要的依赖，这里我因为需要来开发Web应用，因此添加了Spring Web的依赖，又因为我选择了MySQL数据库来存储数据，因此我又添加了MySQL的依赖。 捕获38.PNG 捕获39.PNG 3. 选好依赖后，点击Finish,整个Spring Boot项目创建就完成了。

Spring Boot整合Mybatis

在SpringBoot的配置文件pom.xml中引入Mybatis的起步依赖

捕获34.PNG 引入好配置后，就可以正常使用Mybatis了。

Mybatis 前后端交互详解

图片1.png

如上图所示:

  • controller层是故意暴露出来的，里面是一些接口，用来与前端页面进行交互。
  • service层全是各种方法的接口，用来保护后端方法逻辑的具体实现，防止其源码泄露，该层作用类似于反向代理，每个接口都对应着一个具体方法的实现。
  • service层后面是implement逻辑层，它是整个系统的核心部分，用来与数据库进行交互，实现对应的所有后端逻辑，与前面的service层中的接口一一对应，保证程序的正常进行。
  • 再往后面走，就是dao层，即数据库，该层用于存放所有可以与数据库进行交互的方法接口，是十分重要的地方。
  • mapper层是dao层中数据库方法接口的具体实现,与dao层方法接口一一对应。

前后端交互代码具体实现

项目的具体结构图: image.png OneSpringbootApplication 是启动类，运行该文件，整个项目就启动了。

controller 层:


//注解@RestController用于标记一个类，表明该类是一个
//控制器，并且其下的方法都将前端页面的返回数据作为响应
//(即处理前端页面的http请求)

@RestController
public class HelloController {

    //注解@RequestMapping用于将http请求和处理请求的控制器方法(类方法)
    //关联起来，建立映射关系，
    // 该注解有一个参数value，其作用就是设置请求路径，设置当客户端发送何种请求时，
    //下面的方法才会处理该请求
    
    //该注解的参数value是一个String类型的数组，也就是其中可以存放多个数据
    
    //当前端向"/hello"发出请求时,下面的函数就会接收到请求，
    //并自动调用来处理该请求
    @RequestMapping("/hello")
    public String hello() {
        return "hello world!";
    }


   
//@Autowired 注解用于将下面的对象(已经通过组件扫描注册到了IOC容器中)通过
//依赖注入 从IOC容器中注入到字段(这里字段是“userService”)中以供使用，
// 该对象必须被IOC容器视为一个Bean

    @Autowired
    private UserService userService;

    @RequestMapping("/findById")
    public book findById(Integer ID){
        return userService.findById(ID);
    }
}

service 层的项目结构:

image.png service层的接口:


//该接口只是一个普通的接口，因此需要一个专门的类来实现这个接口中的方法
public interface UserService {
    public book findById(Integer ID);
}

service层的接口的具体实现(impl层):

//@Service注解用于标识一个类作为服务层组件
@Service
public class UserServiceImpl implements UserService {

    //IOC容器通俗解释就是一个负责管理对象生命周期和对象间关系的“大管家”,
    //具体来说，当我们需要某个对象时，我们不再直接在代码中创建它，而是告诉
    //IOC容器我们需要这个对象,容器会根据我们的请求和配置信息，自动创建对象，
    //并处理对象之间的依赖关系,以及一切与项目本身业务逻辑无关的东西
    //(这个对象在项目开始运行时就已经提前创建好了)
    
    // 我们想要使用直接从容器的取出即可，并且容器中已创建的对象可以被本项目其他
    //地方共享和使用，这种对象就是统称为Bean
    //一般被Spring框架提供的注解标注了的类，它们的对象都会被Spring容器视为Bean
    //(Spring容器就是IOC容器)
    //类本身不是Bean,类对应的实例才是Bean




    //@Autowired 注解用于将下面的对象(已经通过组件扫描注册到了IOC容器中)
    //通过依赖注入 从IOC容器中注入到字段(这里字段是“userMapper”)中以供使用，
    // 该对象必须被IOC容器视为一个Bean
    
    @Autowired
    private UserMapper userMapper;

    //当子类继承父类并重写父类的方法时，@Override注解可以帮助编译器检查该方法
    //是否确实重写了父类中的方法
    // 如果子类的方法名、参数列表和返回类型与父类中的方法不一致，那么编译器会
    //报错，提示重写失败,这有助于开发者及时发现并修正重写错误，避免运行时错误
    //的发生
    
    //简单来说，该注解作用就是表明其下面的方法为重写的方法
    @Override
    public book findById(Integer ID) {   
    //对UserService接口中的方法进行重写(即接口方法的具体实现)
        return userMapper.findById(ID);
    }
}

dao层与mapper层:

//@Mapper注解用于标识一个接口为MyBatis的Mapper接口
// 这样，MyBatis就能知道这个接口是专门用于操作数据库的，进而能够自动为这个
//接口创建一个代理实现类
// 这意味着你可以直接在应用程序中注入这个接口的实例，并调用它的方法来执行SQL语句，
//而不需要自己手动实现这个接口
// 即直接拿来使用，不需要再手动的去定义一个类来专门实现这个接口
@Mapper
public interface UserMapper {

    //@Select注解在MyBatis框架中用于直接在Mapper接口的方法上编写SQL查询语句，
    // 从而取代了传统的在XML映射文件中编写SQL语句的方式
    
    //@Select注解内部可以编写具体的SQL查询语句，用于从数据库中查询数据,
    //@Select注解下方的对应方法函数与上面SQL语句成映射关系
    //调用方法函数就会自动执行上面的SQL语句，并将SQL语句的结果作为该方法函数的
    //返回值进行return
    //在@Select注解的SQL语句中，可以使用占位符（如#{param}）来绑定
    //下面方法中的参数
    @Select("select * from test233.book where ID=#{ID}")
    public book findById(Integer ID);
}

通过上面注解@Select和@Mapper来将传统的Dao层和Mapper层合在了一起。

实体类层---entity层:

image.png

public class book {

    private Integer ID;

    private String name;


    public book() {

    }

    public book(Integer ID,String name){
        this.ID=ID;
        this.name=name;
    }

    public Integer getID(){
        return this.ID;
    }

    public void setID(Integer ID){
        this.ID=ID;
    }

    public String getname(){
        return this.name;
    }

    public void setname(){
        this.name=name;
    }
}

该层的作用是用于存放一些实体类，这些实体类将会被用来接收数据库中对应表的数据，一个类对应一张表，表的字段就是类的成员变量。

Spring Boot常用注解

  • 注解@ComponentScan("包路径")用于组件扫描，扫描对应路径下的包当没有包路径时，默认扫描启动类同级的包和各自下面的子包。

组件扫描:如果遇见被Spring Boot提供的注解标记了的类，那么这些类的对象会被视为Bean，SpringBoot会自动将这些类实例化并注入IOC容器之中，供应用程序在运行时使用，若存在组件未被扫描到，则系统不会创建组件当中的Bean实例，也不会创建该组件，与之相关联的其他Bean将会注入失败，与之相关联的功能组件将缺失。

  • 注解@Bean作用:将标记的方法的返回值交给IOC容器，成为IOC容器的bean对象(当Spring容器启动时，它会查找@Configuration注解的类，并调用这些类中的@Bean注解的方法，将返回的实例注册为Bean,注入到IOC容器当中)。
  • 注解@RestController用于标记一个类，表明该类是一个控制器，并且其下的方法都将前端页面的返回数据作为响应(即处理前端页面的http请求)。
  • 注解@RequestMapping用于将http请求和处理请求的控制器方法(类方法)关联起来，建立映射关系，该注解有一个参数value，其作用就是设置请求路径，设置当客户端发送何种请求时，下面的方法才会处理该请求,该注解的参数value是一个String类型的数组，也就是其中可以存放多个数据。
  • 注解@Autowired 用于将其标记的对象(已经通过组件扫描注册到了IOC容器中)通过依赖注入 从IOC容器中注入到字段(这里字段是“userService”)中以供使用。该对象必须被IOC容器视为一个Bean，因为只有这样才能保证IOC容器中拥有该对象。
  • 注解@Service用于标识一个类作为服务层组件。
  • 注解@Override可以帮助编译器检查该方法是否确实重写了父类中的方法。
  • 注解@Mapper用于标识一个接口为Mapper接口,这样，MyBatis就能知道这个接口是专门用于操作数据库的，进而能够自动为这个接口创建一个代理实现类,这意味着你可以直接在应用程序中注入这个接口的实例，并调用它的方法来执行SQL语句，而不需要自己手动实现这个接口;即直接拿来使用，不需要再手动的去定义一个类来专门实现这个接口。
  • 注解@Select在MyBatis框架中用于直接在Mapper接口的方法上编写SQL查询语句，从而取代了传统的在XML映射文件中编写SQL语句的方式，@Select注解内部可以编写具体的SQL查询语句，用于从数据库中查询数据,@Select注解下方的对应方法函数与上面SQL语句成映射关系,调用方法函数就会自动执行上面的SQL语句，并将SQL语句的结果作为该方法函数的返回值进行return,在@Select注解的SQL语句中，可以使用占位符（如#{param}）来绑定标记的方法中的参数。

Spring Boot 配置文件

配置文件的格式

Spring Boot的配置文件有两种格式，分别是.properties和.yaml/yml,两种配置文件的作用并没有什么区别，只是写法上有所不同:

捕获1.PNG

在企业级开发中，更加常用的是.yml格式的文件

捕获2.PNG

书写配置信息

不只是.yml格式的配置文件，.properties格式也是一样的，它们都可以用来书写第三方技术配置信息也可以来书写自定义的配置信息；当书写自定义配置信息时，如下图:

捕获3.PNG

将程序中的一些静态属性放在一起，写成一个配置文件，这样当属性发生变化时就不用改代码，只需要修改配置文件，然后重启服务器即可。 捕获4.PNG 如上图所示，是书写.yml配置文件的一些要求。

捕获5.PNG 如上图中的属性"hobbies",表示该属性是一个数组类型，格式: "-"+" "+数组中的元素

获取配置信息

当属性写入属性文件后，在代码中，我们该如何获取这些属性呢?

捕获6.PNG 如上图所示，通过注解@Value("{键名}")来获得对应的属性，该注解下面的变量就是用来接收对应属性(键)的值的。但是如果属性过多，又不想给每一个变量都写注解，则可以采用下面这种方法:

捕获7.PNG

如上图，在对应的类上面加注解@ConfigurationProperties(prefix="前缀")(这里的前缀也是在配置文件中由用户自定义的),当使用了该注解后，其类下面对应的成员变量名必须与配置文件中同一前缀的属性名相同且一一对应。

Bean 注册

第三方若想注册为Bean(即被SpringBoot自动创建实例并注入IOC容器)，只靠在对应类上添加一般的注解是不行的，这里就需要特殊的注解了。

第三方注册为Bean方式一

方式一，在启动类中添加方法，并在该方法上面添加注解@Bean,如下图:

捕获21.PNG

@Bean注解作用:将标记的方法的返回值交给IOC容器，成为IOC容器的bean对象(当Spring容器启动时，它会查找@Configuration注解的类，并调用这些类中的@Bean注解的方法，将返回的实例注册为Bean)

也可以单独开一个配置类(注解@configuration标记的类)的文件，将所有想注册为Bean的第三方集中处理，如下图:

捕获22.PNG

如果在注解@Bean标记的方法中想使用在IOC容器中已经注册的Bean对象，那么只需要在方法上声明即可，spring会自动的注入，如下图(country是已经在IOC容器中注册好的Bean对象)。

image.png

第三方注册为Bean方式二

方式二, 通过注解@Import将对应的第三方类引入，Spring容器会自动将其类的对象注册为Bean，注入IOC容器中。

  • 引入格式:@Import(xxx.class)
  • 引入位置:整个项目的启动文件当中。

捕获24.PNG

@Import(类名.class)，其中引入的这个类可以普通类，也可以是配置类(@configuration标记了的类),或者是ImportSelector接口实现类。

ImportSelector接口实现类: image.png 如上图所示，我们首先要实现ImportSelector这个接口，重写其中的 selectImports()方法(该方法是自动调用的)，返回值返回一个字符串类型的数组，该数组中的每一个字符串都是用户需要注册为Bean对象的类的地址(全类名)。然后注解@Import只需要引入这个接口实现类的类名即可，这样就避免了因引入的类太多，导致代码不美观的问题。

在一般开发中，ImportSelector接口实现类的方法的返回值的这个字符串数组一般不是写死的，而是从配置文件中读出来的。

在Resources/META-INF/spring/ 目录下，创建后缀名为.imports的配置文件，里面书写上所有自定义的需要注册为Bean的类的地址(全类名)，一个类占一行。

读取配置文件中的信息，示例如下图:

捕获29.PNG 捕获30.PNG 如图，imports是设置的一个字符串列表，用于存放配置文件中的各个类的全类名;is 是获取到的输入流，后面的 "common.imports" 是配置文件名,整行代码的作用就是将配置文件中的数据转换成输入流存入变量is中，下面的变量br是对输入流的一个封装，将其封装成一个缓冲字符流。while循环是用来按照每一行来读取缓冲字符流当中的数据，并用字符串变量line来接收，将每一行数据添加至字符串列表imports当中，所有数据读取完毕后，要关闭缓冲字符流br；最后，将字符串列表转换成字符串数组返回回去。

自定义组合注解

捕获31.PNG 如上图所示，选择Annotation,创建自定义的组合注解。

捕获32.PNG 如上图所示，上面两个注解都是必不可少的。第一个是表明该自定义注解可以在类上使用，第二个表明该自定义注解在系统运行期间，一直存在。除了这两个注解，其他的均可以自定义。若要使用这个注解，就像普通注解一样直接使用即可，注解名为创建的组合注解的文件名。常用于实现下图第三条:

捕获33.PNG

Bean 的注册条件

用户可以通过注解@Conditional的衍生注解来设置对象注册为Bean的条件，常用的注解如下图所示。

image.png

在配置类中，注解@Bean所标记的方法，其返回值会被注册为Bean，我当然可以提前为要注册为Bean的对象赋值，如下图，在方法的参数上通过注解@Value("${键名}")来确保每个参数被传入指定的值。注解@ConditionalOnProperty(prefix="前缀",name={"键名1","键名2"}) 来判断配置文件中是否存在对应属性，若不存在，则其下面整个方法的返回值将不再被注册为Bean。

image.png 注解@ConditionalOnMissingBean(类名.class),如下图所示,如果IOC容器中不存在Country类的Bean对象，则执行下面的方法，注入Province,否则不注入。

image.png

注解@ConditionalOnClass(name="类的完整路径名"),如下图所示，如果当前配置环境存在指定的类，则执行下面的方法，注入Province,否则不注入。 image.png

自动配置的原理

自动配置就是在SpringBoot程序启动后，起步依赖中的一些Bean对象会自动注入到IOC容器之中。

原理:在jar包内定义了一些类，目的是想要这些类的实例作为Bean注入到IOC容器中，即自动注入;首先定义一个配置类，配置类中用注解@Bean来标记方法，通过这些方法，SpringBoot会将它们返回的实例作为Bean注入到IOC容器中，再定义一个自动配置类，加上两个注解@import(配置类类名.class)和@AutoConfiguration;前者引入了配置类,保证其在不同级目录下也可以使用，后者标识这是一个自动配置类。最后在项目的resources目录下的META-INF目录下的spring目录下再定义一个后缀名为.imports的文件，在文件中加入该自动配置类的全类名;当系统启动时，系统会在该目录下("/resources/META-INF/spring/xxx.imports")的配置文件中找是否有自动配置类(注解@AutoConfiguration标记的类)，有就自动调用实例化该类。实例化该类，会导致系统通过@import访问到配置类，配置类中的方法会被自动调用，这样就自动配置就搞定了。

@Configuration与@AutoConfiguration注解的区别:

1. @Configuration 必须通过组件扫描，才能自动配置Bean，若不在启动类的同级目录或子目录下，则需要@ComponentScan("路径")来专门指定扫描。

  1. @AutoConfiguration 会被加载执行两次，一次是由@ComponentScan（如果配置了的话），另一次是由自动配置机制，也就是说只要该类在该项目下，且配置文件.imports 里有该类的全类名,该类就会被系统自动调用，自动配置Bean。
  2. @Configuration与@AutoConfiguration注解一般配合使用。
相关内容
本来干活干的好好的，结果新来的后端这么卷，他说他五一放假不出去玩，他说他要继续写接口，要把新项目的接口写完，我替我前端的组员谢谢他啊[尬笑]
对接后端接口被挑战能力不行（吐槽贴，不会因为这个问题去挑战什么）
（经验分享）一个95后Java后端研发攻城狮❤️入行半年工作经验、心得大盘点
你们的后端新增数据和详情返回的数据会用不同的字段名称给前端吗，比如入参是listDto，出参就变成listVo了
后端每日一题 2：DNS 解析过程
后端开发一定要买 macbook 吗
后端缓存使用场景/问题/方案
后端每日一题 1：说一下三次握手
快速入门Web开发（中）后端开发（有重点）
前端一分钟内入门后端：来玩NestJS吧