0
点赞
收藏
分享

微信扫一扫

2-尚硅谷谷粒学苑

RJ_Hwang 2022-04-17 阅读 53
javaspring bootswaggerrestful后端

开发讲师管理模块

配置文件

在resources下创建application.yml文件

#服务端口
server:
  port: 8001
#服务名 springcloud使用的
spring:
  application:
    name: service-edu
#环境设置：dev开发环境、test测试环境、prod生产环境
  profiles:
    active: dev
#mysql数据库连接
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/guli?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8
    username: root
    password: root
#Mybatis日志
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

编写controller、service、mapper内容

mp提供了代码生成器CodeGenerator，生成相关代码
1.在test的java目录下创建包com.atguigu.demo
2.CodeGenerator.java放入包com.atguigu.demo中
注意：最好改成绝对路径；mp需要单独配置数据库
CodeGenerator.java（复制时，最好复制上导入的包，要不然可能会爆红）

package com.atguigu.demo;


import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import org.junit.Test;


public class CodeGenerator {

    @Test
    public void run() {

        // 1、创建代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 2、全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        //最好修改为绝对路径
        gc.setOutputDir("E:\\deaProjects\\guli\\service\\service_edu" + "/src/main/java");

        gc.setAuthor("cai"); //作者名字
        gc.setOpen(false); //生成后是否打开资源管理器
        gc.setFileOverride(false); //重新生成时文件是否覆盖

        //TeacherService
        gc.setServiceName("%sService");	//去掉Service接口的首字母I

        gc.setIdType(IdType.ID_WORKER_STR); //主键生成策略 19位 两种 ID_WORKER  ID_WORKER_STR
        gc.setDateType(DateType.ONLY_DATE);//定义生成的实体类中日期类型
        gc.setSwagger2(true);//开启Swagger2模式

        mpg.setGlobalConfig(gc);

        // 3、数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/guli?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        dsc.setDbType(DbType.MYSQL);//数据库类型
        mpg.setDataSource(dsc);

        // 4、包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("eduservice"); //模块名
        //包  com.atguigu.eduservice
        pc.setParent("com.atguigu");
        //包  com.atguigu.eduservice.controller
        pc.setController("controller");
        pc.setEntity("entity");
        pc.setService("service");
        pc.setMapper("mapper");
        mpg.setPackageInfo(pc);

        // 5、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("edu_teacher");//数据库表名,多个的话,可以逗号隔开
        strategy.setNaming(NamingStrategy.underline_to_camel);//数据库表映射到实体的命名策略
        strategy.setTablePrefix(pc.getModuleName() + "_"); //生成实体时去掉表前缀
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);//数据库表字段映射到实体的命名策略
        strategy.setEntityLombokModel(true); // lombok 模型 @Accessors(chain = true) setter链式操作
        strategy.setRestControllerStyle(true); //restful api风格控制器
        strategy.setControllerMappingHyphenStyle(true); //url中驼峰转连字符
        mpg.setStrategy(strategy);

        // 6、执行
        mpg.execute();
    }
}

3.执行CodeGenerator

编写eduteacher后台管理api接口

查询所有讲师

1.创建启动类
注意启动类的位置！！

@SpringBootApplication
public class EduApplication {
    public static void main(String[] args) {
        SpringApplication.run(EduApplication.class,args);
    }
}

2.创建配置类，配置mapper扫描和其他（config包下）

@MapperScan("com.atguigu.eduservice.mapper")
public class EduConfig {
    
}

3.查询所有讲师 —controller中

//@RestController：@Controller创建交给spring管理 @ResponseBody返回json数据
@RestController
@RequestMapping("/eduservice/teacher")
public class EduTeacherController {

    //注入service
    @Autowired
    private EduTeacherService teacherService;
    //查询讲师所有数据
    //rest风格
    @GetMapping("findAll")
    public List<EduTeacher> findAllTeacher(){
        //调用service中的方法，实现查询所有的操作
        List<EduTeacher> list = teacherService.list(null);
        return list;
    }
}

4.最终测试
重新启动主启动类
http://localhost:8001//eduservice/teacher/findAll
在这里插入图片描述

5.统一返回的json时间格式
默认情况下，json时间格式是带有时区并且是世界标准时间，和我们的时间相差8个小时，在application.yml中设置

#返回json的全局时间格式
jackson:
    date-format: yyyy-MM-dd HH:mm:ss
    time-zone: GMT+8

6.重新启动
在这里插入图片描述

逻辑删除讲师

1.EduConfig类中配置逻辑删除插件

@Configuration
@MapperScan("com.atguigu.eduservice.mapper")
public class EduConfig {
    /**
     * 逻辑删除插件
     */
    @Bean
    public ISqlInjector sqlInjector() {
        return new LogicSqlInjector();
    }
}

2.逻辑删除属性上添加注解

@ApiModelProperty(value = "逻辑删除 1（true）已删除， 0（false）未删除")
    @TableLogic
    private Boolean isDeleted;

3.编写controller中的方法

    //逻辑删除所有讲师
    //id值需要通过路径进行传递
    @DeleteMapping("{id}")
    //@PathVariable获取路径中的id值
    public boolean removeTeacher(@PathVariable String id){
        boolean flag = teacherService.removeById(id);
        return flag;
    }

4.如何测试？
借助工具测试：postman（了解，主要是前端用），swagger（重点）

整合swagger

优点：1.生成接口在线文档；2.方便接口测试
整合swagger
1.新建公共模块
guli父模块下创建子模块common，在common中创建子模块service_base
2.修改子模块common的pom文件

    <artifactId>common</artifactId>
    <packaging>pom</packaging>

添加依赖

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <scope>provided </scope>
        </dependency>

        <!--mybatis-plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <scope>provided </scope>
        </dependency>

        <!--lombok用来简化实体类：需要安装lombok插件-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <scope>provided </scope>
        </dependency>

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <scope>provided </scope>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <scope>provided </scope>
        </dependency>

        <!-- redis -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

        <!-- spring2.X集成redis所需common-pool2
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
            <version>2.6.0</version>
        </dependency>-->
    </dependencies>

3.service_base模块的java下建立com.atguigu.servicebase包
创建swagger的配置类

package com.atguigu.servicebase;

import com.google.common.base.Predicates;
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.service.Contact;
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 //swagger注解
public class SwaggerConfig {

    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();
    }

    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("尚硅谷-谷粒学苑")
                .description("本文档描述了谷粒学苑的接口定义")
                .version("1.0")
                .contact(new Contact("菜菜", "https://blog.csdn.net/qq_44918461?type=blog", "380693433@qq.com"))
                .build();
    }
}

4.具体使用
（1）在service模块的pom中 引入swagger

		<!--引入swagger-->
        <dependency>
            <groupId>com.atguigu</groupId>
            <artifactId>service_base</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

（2）service_edu的启动类中加注解，设置包扫描规则
目的：要使启动类扫描到swagger类，要加注解，不然只扫描当前包下的内容

@SpringBootApplication
@ComponentScan(basePackages = {"com.atguigu"} )//设置包的扫描规则
public class EduApplication {
    public static void main(String[] args) {
        SpringApplication.run(EduApplication.class,args);
    }
}

启动主启动类
（3）访问swagger
http://localhost:8001/swagger-ui.htm
了解：定义接口说明和参数说明
定义在类上：@Api
定义在方法上：@ApiOperation
定义在参数上：@ApiParam

举报

相关推荐

尚硅谷_谷粒学苑-微服务+全栈在线教育实战项目之旅

微服务javamaven

尚硅谷谷粒商城第七天 elasticsearch

javaelasticsearch

尚硅谷谷粒商城第一天 基础

javaspring cloudspring boot分布式架构

尚硅谷谷粒商城第十五天 订单、库存

java后端架构分布式restful

尚硅谷谷粒商城第十三天 单点登录（jwt）

java后端架构restful

JVM 尚硅谷

java开发语言后端

尚硅谷-React

前端reactreact.js前端框架

尚硅谷谷粒商城第十四天 购物车、SpringTask

javaspring bootspring cloudrestful后端

尚硅谷谷粒商城第四天 环境搭建、nginx、CORS、OSS

javanginxlinux后端

尚硅谷的尚融宝项目

mybatisjavaspring boot
0 条评论