美文网首页
[前端学java06-SpringBoot实战] 注入 + Sw

[前端学java06-SpringBoot实战] 注入 + Sw

作者: woow_wu7 | 来源:发表于2021-10-10 14:20 被阅读0次

导航

[react] Hooks

[React 从零实践01-后台] 代码分割
[React 从零实践02-后台] 权限控制
[React 从零实践03-后台] 自定义hooks
[React 从零实践04-后台] docker-compose 部署react+egg+nginx+mysql
[React 从零实践05-后台] Gitlab-CI使用Docker自动化部署

[源码-webpack01-前置知识] AST抽象语法树
[源码-webpack02-前置知识] Tapable
[源码-webpack03] 手写webpack - compiler简单编译流程
[源码] Redux React-Redux01
[源码] axios
[源码] vuex
[源码-vue01] data响应式 和 初始化渲染
[源码-vue02] computed 响应式 - 初始化，访问，更新过程
[源码-vue03] watch 侦听属性 - 初始化和更新
[源码-vue04] Vue.set 和 vm.$set
[源码-vue05] Vue.extend

[源码-vue06] Vue.nextTick 和 vm.$nextTick
[部署01] Nginx
[部署02] Docker 部署vue项目
[部署03] gitlab-CI

[数据结构和算法01] 二分查找和排序

[深入01] 执行上下文
[深入02] 原型链
[深入03] 继承
[深入04] 事件循环
[深入05] 柯里化 偏函数 函数记忆
[深入06] 隐式转换 和 运算符
[深入07] 浏览器缓存机制（http缓存机制）
[深入08] 前端安全
[深入09] 深浅拷贝
[深入10] Debounce Throttle
[深入11] 前端路由
[深入12] 前端模块化
[深入13] 观察者模式 发布订阅模式 双向数据绑定
[深入14] canvas
[深入15] webSocket
[深入16] webpack
[深入17] http 和 https
[深入18] CSS-interview
[深入19] 手写Promise
[深入20] 手写函数
[深入21] 数据结构和算法 - 二分查找和排序
[深入22] js和v8垃圾回收机制
[深入23] JS设计模式 - 代理，策略，单例

[前端学java01-SpringBoot实战] 环境配置和HelloWorld服务
[前端学java02-SpringBoot实战] mybatis + mysql 实现歌曲增删改查
[前端学java03-SpringBoot实战] lombok，日志，部署
[前端学java04-SpringBoot实战] 静态资源 + 拦截器 + 前后端文件上传
[前端学java05-SpringBoot实战] 常用注解 + redis实现统计功能
[前端学java06-SpringBoot实战] 注入 + Swagger2 3.0 + 单元测试JUnit5

(一) 前置知识

(1) 一些单词

condition 条件 // conditional 条件的 adj
camel 骆驼
swagger 大摇大摆 虚张声势
contact 接触 联系
implicit 隐藏 隐式
assertions 断言
qualifier 限定符 修饰符

(二) Swagger2 3.0

(1) 安装Swagger2 maven 依赖场景启动器starter

pom.xml
-------

<!-- Swagger -->
<!-- 自动生成 ( 接口文档 ) 及 ( 自测工具 ) -->
<!-- Swagger2 3.0 只需要 ( springfox-boot-starter ) 就可以了 -->
<!-- Swagger2 2.x 则需要 ( springfox-swagger2 ) 和 ( springfox-swagger-ui )-->

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

<!-- (1) springfox-swagger2 -->
<!--<dependency>-->
<!--<groupId>io.springfox</groupId>-->
<!--<artifactId>springfox-swagger2</artifactId>-->
<!--<version>3.0.0</version>-->
<!--</dependency>-->
<!-- (2) springfox-swagger-ui -->
<!--dependency>-->
<!--<groupId>io.springfox</groupId>-->
<!--<artifactId>springfox-swagger-ui</artifactId>-->
<!--<version>3.0.0</version>-->
<!--</dependency>-->

(2) 编写 Swagger2 的配置类

src/main/java/com.example.demo/config/Swagger2Config.java
-------

@Configuration // 标注当前类是一个启动类，即项目启动时就要去加载了
@EnableSwagger2 // 开启 Swagger2 的配置
public class Swagger2Config {

    @Bean // 把该组件添加到IOC容器中
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // Swagger2进行包扫描，扫描 controller，这里填写 controller 的文件夹全路径
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 标题
                .title("react-admin-java-api 使用Swagger2构建RESTful APIs")
                // 描述
                .description("react-admin-java-api Swagger2的接口文档")
                // 作者信息
                .contact(new Contact("woow_wu7", "https://github.com/woow-wu7/7-react-admin-java", "woow_wu7@gmail.com"))
                // 服务网址
                .termsOfServiceUrl("http://120.53.220.141:81/admin-home")
                .version("1.0")
                .build();
    }
}

(3) 访问 http://localhost:7777/swagger-ui/index.html

  • 如果是远程部署后访问地址：服务器地址/swagger-ui/index.html
    image

(4) 相关注解

  • controller
    • @Api 用在请求的类上，该注解最好不要设置，中文不是很好
    • @ApiOperation 用于controller类的方法上，说明方法的用途和作用
    • @ApiParam 用于请求方法的参数 => 个人感觉侵入性太强，严重影响了阅读，混入业务代码很乱
    • @ApiImplicitParams 用于请求方法上 => 主要用于post请求
    • @ApiImplicitParam 用于@ApiImplicitParams参数中
  • models => bean || model || dto
    • @ApiModel
    • @ApiModelProperty
    // 查
    @GetMapping("/getMusicListTest")
    @ApiOperation(value = "查询歌曲列表") // Swagger2
    public PaginationTestDTO getMusicList(
            @RequestParam(value = "current", defaultValue = "1")
                @ApiParam(name = "current", value = "当前页", defaultValue = "1", required = false) Integer current,
            @RequestParam(value = "pageSize", defaultValue = "10")
                @ApiParam(name = "pageSize", value = "每页数量", defaultValue = "10", required = false) Integer pageSize,
            @RequestParam(value = "searchKey", defaultValue = "")
                @ApiParam(name = "searchKey", value = "搜索框", defaultValue = "", required = false) String searchKey
    ) {
        return musicTestService.getMusicList(current, pageSize, searchKey);
    }

@Data
@AllArgsConstructor
@NoArgsConstructor
@ApiModel("歌曲")
public class MusicTestBean {
    @ApiModelProperty(name = "name", value = "歌名")
    private String name; // 歌名

    @ApiModelProperty(name = "album", value = "专辑")
    private String album; // 专辑

    @ApiModelProperty(name = "singer", value = "歌手")
    private String singer; // 歌手

    private Integer id;
    private String startTime;
    private String endTime;
}
image
image

(三) 单元测试 JUnit5

  • SpringBoot已经集成了JUint5
  • 使用非常简单
    • 编写测试方法，并用 @Test来标注 (unit5版本)
    • JUnit的测试类具有spring的功能
      • 比如可以使用 @Autowired 来自动引入IOC中的组件
      • 比如可以使用 @Transactional 来标注测试方法，测试完成后自动回滚，事务
  • 官方文档

(1) 引入maven场景启动器

pom.xml
-------

<!-- spring-boot-starter-test -->
<!-- 单元测试 场景启动器 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

(2) 单元测试常用注解

  • @Test 表示该方法是测试方法
  • @ParameterizedTest 表示该方法是参数测试
  • @RepeatedTest 表示方法可重复执行
  • @DisplayName 为测试类或测试方法设置展示名称
  • @BeforeEach 表示在每个单元测试前执行
  • @AfterEach
  • @BeforeAll 在所有单元测试前执行
  • @AfterAll
  • @Tag 单元测试类别
  • @Disabled 表示测试类或测试方法不执行
  • @Timeout 测试方法超过定时后将返回错误
  • @ExtendWith 为测试类或测试方法提供扩展类引用
  • @BeforeAll 和 @BeforeEach 的区别
    • @BeforEach在每个测试方法执行前都会执行，一个测试类中可能有多个测试方法，因此@BeforeEach可能会多次执行
    • @BeforeAll在所有测试方法执行前执行，也就是说一个测试类中@BeforeAll只会执行一次
src/test/java/com.example.demo/Junit5Test.java
-------

/**
 * @SpringBootTest 是下面这些注解的复合注解
 *    @BootstrapWith(SpringBootTestContextBootstrapper.class)
 *    @ExtendWith(SpringExtension.class) =>  @ExtendWith
 */
@SpringBootTest
@DisplayName("JUnit5功能测试")
public class Junit5Test {
    @Test
    @DisplayName("测试方法1 @DisplayName 注解")
    public void testDisplayName1() {
        System.out.println("@DisplayName1");
    }

    @Test
    @DisplayName("测试方法2 @DisplayName 注解")
    public void testDisplayName2() {
        System.out.println("@DisplayName2");
    }

    @Test
    @Disabled // 禁用
    @DisplayName("测试方法 @Disabled 注解")
    public void testDisabled() {
        System.out.println("@Disabled");
    }

    @Test
    @RepeatedTest(5) // 重复测试5次
    @DisplayName("测试方法 @RepeatedTest 注解")
    public void testRepeatedTest() {
        System.out.println("@RepeatedTest -----5");
    }

    @Test
    @Timeout(value = 1000, unit = TimeUnit.MILLISECONDS) // 超出时间报错
    public void testTimeout() throws InterruptedException {
        Thread.sleep(1200);
        System.out.println("@Timeout");
    }

    @BeforeEach
    public void testBeforeEach() {
        System.out.println("@BeforeEach");
    }

    @AfterEach
    public void testAfterEach() {
        System.out.println("@AfterEach");
    }

    @BeforeAll
    static public void testBeforeAll() {
        // 注意: @BeforeAll 和 @AfterAl 标注的方法必须是 ( 静态方法 )
        System.out.println("@BeforeAll");
    }

    @AfterAll
    static public void testAfterAll() {
        System.out.println("@AfterAll");
    }
}
image

(3) 断言 assertions

  • 所有的测试运行结束后，会有一个详细的测试报告

(3-1) 简单断言

  • Assertions.assertEquals
  • Assertions.assertSame
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertSame;

@SpringBootTest
public class Junit5Test2 {
    int cal(int i, int j) {
        return i+j;
    }
    // (一) 断言：如果前面的断言失败，后面的代码就都不会执行
    @Test
    @DisplayName("测试简单断言 assertions")
    void testSimpleAssertions() {
        int cal = cal(2,3);
        // (1) assertEquals => 断言相等 
        assertEquals(5, cal, "两个值不相等"); // ( expected期望值 和 actual真实计算的值 ) 是否相等
        // (2) assertSame => 断言是不是同一个对象
        Object obj1 = new Object();
        Object obj2 = obj1;
        assertSame(obj1, obj2, "是不是同i个对象 => 不是同一个对象"); // 第三个参数表示 断言失败后会显示的信息
    }
}
image

(3-2) 数组断言

  • Assertions.assertArrayEquals
    @Test
    @DisplayName("测试数组断言1 assertArrayEquals")
    public void testAssertArrayEquals1() {
        assertArrayEquals(new int[]{1, 2}, new int[]{1, 2}, "数据内容不相等");
    }

    @Test
    @DisplayName("测试数组断言2 assertArrayEquals")
    public void testAssertArrayEquals2() {
        assertArrayEquals(new int[]{1, 2, 3}, new int[]{1, 2}, "数据内容不相等");
    }

(3-3) 组合断言

  • Assertion.assertAll
  • 有三个assertion，分别是a b c，要显现a断言要在b和c都成功后才成功
    @Test
    @DisplayName("测试组合断言 assertAll")
    public void all() {
        assertAll("test",
                () -> assertTrue(true && true, "不是true"),
                () -> assertEquals(1, 2, "不相等")
        );
        System.out.println("Assertion.assertAll只有断言都成功，该log才会打印");
    }
image

(四) Spring IOC 注入 ----- 注意是Spring不是SpringBoot

  • 分为 ( 手动注入 ) 和 ( 自动注入 )

(1) 手动注入

  • set方法注入
    • 1.属性字段提供set方法
    • 2.在xml配置文件中通过 bean标签的子标签property标签指定属性
    • 3.这样在向IOC添加组件时，就会自动的调用set注入到IOC中
  • 构造器注入 - 和set类似
    image

(2) 自动注入

  • @Resource
  • @Autowired

(2-1) 自动注入环境配置

src/main/resources/bean.xml
-------

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd">

    <!--手动注入-->
    <!-- id: 表示组件在容器中的名字，随便取 -->
    <!-- class: 表示bean对象的全路径 -->
    <!-- property: 表示bean对象中的属性 -->
    <!-- name: 表示具体的属性名 -->
    <!-- ref: 表示容器中的组建名，即bean标签的中id属性 -->

    <!--<bean id="userService" class="org.example.UserService">-->
        <!--property name="userBean" ref="userBean"/>-->
    <!--</bean>-->
    <!--<bean id="userBean" class="org.example.UserBean"></bean>-->

    <!--自动注入-->
    <!--1. 自动注入配置需要添加 beans => xmlns:context="http://www.springframework.org/schema/context" -->
    <!--2. 自动注入配置需要添加 beans => xsi:schemaLocation也要添加一些内容，如上 -->
    <!--3. 自动注入配置需要添加 <context:annotation-config/> 如下 -->
    <!--4. 注意自动注入和手动注入xml配置除了123还有一个区别：UserService中要使用userBean，自动注入不需要使用 property -->
    <context:annotation-config/>
    <bean id="userService" class="org.example.UserService"></bean>
    <bean id="userBean" class="org.example.UserBean"></bean>
</beans>

(2-2) @Resource 注解的使用

/**
 * 手动注入
 * set 方法注入
 * 1. 属性字段提供set方法
 * 2. 在xml配置文件中通过 bean标签的子标签property标签指定属性
 * 3. 这样在向IOC添加组件时，就会自动的调用set注入到IOC中
 */

/**
 * 自动注入
 *
 * @Resource 可以实现自动注入，通过反射类实现
 * 1. 默认通过 ( 属性字段名称 ) 来查找对应的 ( bean对象 ) => ( 属性名 ) 和 ( bean标签 id ) 保持一致
 * 2. 如果 ( 属性名 ) 和 ( bean标签id ) 不一致，则会通过 ( bean标签的class ) 去查找
 * 3. 可以提供set，也可以不提供set
 * 4. 可以标注在 ( 属性上 ) 或者 ( set方法 ) 上
 * 5. 可以设置name属性，但需要和bean标签的id保持一致，  @Resource(name="userBean")
 * 6. 6.1 当注入接口时，如果接口只有一个实现类，则正常实例化
 *    6.2 如果接口有多个实现类，需要通过参数name来指定具体的实现类，参数就是xml配置文件中bean标签的id
 */
public class UserService {
    // 手动实例话
    // UserBean userBean = new UserBean();

    // JavaBean对象
    @Resource(name = "userBean")
    private UserBean userBean;

    @Resource(name = "userImplements")
    // 该接口有两个实现类 ( UserImplements ) 和 ( UserImplements2)
    // 此时需要通过 @Resource(name = "xml配置文件中bean标签的id")
    private UserInterface userInterface;

    public void test() {
        userBean.getName2();
        userInterface.getName3();
    }
}
image

(2-3) @Autowired + @Qualifier

  • @AutoWired 默认是按照xml中的bean标签的 class 属性去查找的
  • 属性字段可以提供set方法，也可以不提供set方法
  • @Autowire可以写在set方法上，也可以写在属性上
  • 如果想要通过指定名称查找bean对象，需要结合 @Qualifier 注解
  • @Qualifier(value = "autowiredBean2") 中的value的值和xml中bean标签的 id 属性一一对应
src/main/resources/bean.xml
-------
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd">

    <!--手动注入-->
    <!-- id: 表示组件在容器中的名字，随便取 -->
    <!-- class: 表示bean对象的全路径 -->
    <!-- property: 表示bean对象中的属性 -->
    <!-- name: 表示具体的属性名 -->
    <!-- ref: 表示容器中的组建名，即bean标签的中id属性 -->

    <!--<bean id="userService" class="org.example.UserService">-->
        <!--property name="userBean" ref="userBean"/>-->
    <!--</bean>-->
    <!--<bean id="userBean" class="org.example.UserBean"></bean>-->

    <!--自动注入-->
    <!--1. 自动注入配置需要添加 beans => xmlns:context="http://www.springframework.org/schema/context" -->
    <!--2. 自动注入配置需要添加 beans => xsi:schemaLocation也要添加一些内容，如上 -->
    <!--3. 自动注入配置需要添加 <context:annotation-config/> 如下 -->
    <!--4. 注意自动注入和手动注入xml配置除了123还有一个区别：UserService中要使用userBean，自动注入不需要使用 property -->
    <context:annotation-config/>
    <bean id="userService" class="org.example.UserService"></bean>
    <bean id="userBean" class="org.example.UserBean"></bean>
    <bean id="userImplements" class="org.example.UserImplements"></bean>
    <bean id="userImplements2" class="org.example.UserImplements2"></bean>

    <bean id="autowiredBean2" class="org.example.AutowiredBean"></bean>
</beans>

src/main/java/org.example/UserService.java
-------

/**
 * 手动注入
 * set 方法注入
 * 1. 属性字段提供set方法
 * 2. 在xml配置文件中通过 bean标签的子标签property标签指定属性
 * 3. 这样在向IOC添加组件时，就会自动的调用set注入到IOC中
 */

/**
 * 自动注入
 *
 * @Resource 可以实现自动注入，通过反射类实现
 * 1. 默认通过 ( 属性字段名称 ) 来查找对应的 ( bean对象 ) => ( 属性名 ) 和 ( bean标签 id ) 保持一致
 * 2. 如果 ( 属性名 ) 和 ( bean标签id ) 不一致，则会通过 ( bean标签的class ) 去查找
 * 3. 可以提供set，也可以不提供set
 * 4. 可以标注在 ( 属性上 ) 或者 ( set方法 ) 上
 * 5. 可以设置name属性，但需要和bean标签的id保持一致，  @Resource(name="userBean")
 * 6. 6.1 当注入接口时，如果接口只有一个实现类，则正常实例化
 *    6.2 如果接口有多个实现类，需要通过参数name来指定具体的实现类，参数就是xml配置文件中bean标签的id
 */

/**
 * 自动注入
 *
 * @Autowired 可以实现自动注入，通过反射类实现
 * 1. @Autowired注解模式是通过 xml配置文件中的bean标签的class属性去查找bean对象的，与属性字段没有关系
 * 2. 可以提供set，也可以不提供set
 * 3. 可以标注在 ( 属性上 ) 或者 ( set方法 ) 上
 * 4. 如果想要通过指定名称查找bean对象，需要结合 @Qualifier注解
 */

public class UserService {
    // 手动实例话
    // UserBean userBean = new UserBean();

    // JavaBean对象
    @Resource(name = "userBean")
    private UserBean userBean;

    @Resource(name = "userImplements")
    // 该接口有两个实现类 ( UserImplements ) 和 ( UserImplements2)
    // 此时需要通过 @Resource(name = "xml配置文件中bean标签的id")
    private UserInterface userInterface;

    @Qualifier(value = "autowiredBean2")
    @Autowired
    AutowiredBean autowiredBean;

    public void test() {
        userBean.getName2();
        userInterface.getName3();
        autowiredBean.testAutowired();
    }
}
image

项目源码

资料

相关文章

网友评论

      本文标题：[前端学java06-SpringBoot实战] 注入 + Sw

      本文链接：https://www.haomeiwen.com/subject/ajyholtx.html

      延伸阅读

      深度阅读

      • 您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

      栏目导航

      热点阅读

      关于我们|服务条款|联系我们|[前端学java06-SpringBoot实战] 注入 + Sw|投稿指南|网站地图|RSS订阅|排版工具|手机版

      提供经典美文摘抄,优美散文欣赏,现代诗歌精选,短篇小说,心情随笔,表白情书范文,故事会在线阅读欣赏

      Copyright © 2014-2023 Haomeiwen.com All Rights Reserved. 好美文阅读网 版权所有

      备案信息：桂公网安备 45052102000051号 · 桂ICP备13007215号-3

      本站所收录作品、热点评论等信息部分来源互联网，目的只是为了系统归纳学习和传递资讯

      所有作品版权归原创作者所有，与本站立场无关，如不慎侵犯了你的权益，请联系我们告知，我们将做删除处理！