谷粒学院-讲师管理接口开发

最新推荐文章于 2023-01-04 09:20:53 发布

Stiver_Mr

最新推荐文章于 2023-01-04 09:20:53 发布

阅读量674

点赞数 1

分类专栏：在线教育-谷粒学院文章标签： java

本文链接：https://blog.csdn.net/m0_46726686/article/details/107167042

版权

在线教育-谷粒学院专栏收录该内容

8 篇文章 1 订阅

订阅专栏

01-讲师管理接口开发

一、启动应用程序

1、创建application.yml文件

server:
  port: 8001  # 服务端口
spring:
  profiles:
    active: dev #环境设置
  application:
    name: service-edu #服务名
  datasource:  #数据库连接
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/guli_edu?serverTimezone=GMT%2B8
    username: root  //mysql数据库用户名 根据自己的sql
    password: root  //密码
#mybatis日志
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

2、创建SpringBoot配置文件

在service-base中创建MybatisPlusConfig

package com.atguigu.guli.service.base.config;

@EnableTransactionManagement
@Configuration
@MapperScan("com.atguigu.guli.service.*.mapper")
public class MybatisPlusConfig {

    /**
     * 分页插件
     */
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }
}

3、创建SpringBoot启动类

扫描com.atguigu.guli

package com.atguigu.guli.service.edu;

@SpringBootApplication
@ComponentScan({"com.atguigu.guli"})
public class ServiceEduApplication {
    
    public static void main(String[] args) {
        SpringApplication.run(ServiceEduApplication.class, args);
    }
}

4、运行启动类

查看控制台8001端口是否成功启动

二、讲师列表API

1、编写讲师管理接口

修改TeacherController的包名，添加 “.admin”

修改TeacherController的@RequestMapping，添加 “/admin”

package com.atguigu.guli.service.edu.controller.admin;

/**
 * <p>
 * 讲师 前端控制器
 * </p>
 *
 * @author Strive
 * @since 2020-06-16
 */
@RestController
@RequestMapping("/admin/edu/teacher")
public class TeacherController {
    @Autowired
    private TeacherService teacherService;

    @GetMapping("list")
    public List<Teacher> listAll() {
        return teacherService.list();
    }

}

2、统一返回的json时间格式

默认情况下json时间格式带有时区，并且是世界标准时间，和我们的时间差了八个小时

在application.yml中设置

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

Teacher.java 的 joinDate字段添加数据类型转换，可以覆盖全局配置

@JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd")

访问：http://localhost:8001/admin/edu/teacher/list

3、重启程序

访问：http://localhost:8001/admin/edu/teacher/list 查看结果json数据

三、逻辑删除API

1、添加删除方法

TeacherController添加removeById方法

@DeleteMapping("remove/{id}")
public boolean removeById(@PathVariable String id){
    return teacherService.removeById(id);
}

2、使用postman测试删除

02-配置Swagger2

一、Swagger2介绍

https://swagger.io/

前后端分离开发模式中，api文档是最好的沟通方式。

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)
规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)
一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)
可测性 (直接在接口文档上进行测试，以方便理解业务)

二、配置Swagger2

1、依赖

service-base

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

2、创建Swagger2配置文件

在service-base中创建Swagger2Config

package com.atguigu.guli.service.base.config;

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket webApiConfig() {

        return new Docket(DocumentationType.SWAGGER_2);
   }     
}

3、重启服务器查看接口

http://localhost:8001/swagger-ui.html

三、常见注解

1、API模型

entity的实体类中可以添加一些自定义设置，例如：

定义样例数据

@ApiModelProperty(value = "入驻时间", example = "2010-01-01")
@JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd")
private Date joinDate;

@ApiModelProperty(value = "创建时间", example = "2019-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT)
private Date gmtCreate;

@ApiModelProperty(value = "更新时间", example = "2019-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmtModified;

2、定义接口说明和参数说明

定义在类上：@Api

定义在方法上：@ApiOperation

定义在参数上：@ApiParam

注解：@ApiOperation(“所有讲师列表”)

@ApiOperation(value = “根据id删除讲师”, notes = “根据id删除讲师”)

注解：@ApiParam(value = “讲师id”,required = true)

注解：@Api(tags = “讲师管理”)

Swagger2Config类

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket webApiConfig() {

        return new Docket(DocumentationType.SWAGGER_2)
               .groupName("webApi")
               .apiInfo(webApiInfo());
    }
    private ApiInfo webApiInfo() {
        return new ApiInfoBuilder()
                .title("课程中心API文档")
                .description("本文档描述了课程中心微服务接口定义")
                .version("1.0")
                .contact(new Contact("Strive", "http://atguigu.com", "136332183@qq.com"))
                .build();
    }
}

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket adminApiConfig() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("adminApi")
                .apiInfo(adminApiInfo())
                .select()
                .paths(Predicates.and(PathSelectors.regex("/admin/.*")))
                .build();
    }

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

    private ApiInfo adminApiInfo() {

        return new ApiInfoBuilder()
                .title("后台管理系统 - 谷粒学院API文档")
                .description("本文档描述了谷粒学院的接口")
                .version("2.0")
                .contact(new Contact("Strive", "http://atguigu.com", "136332183@qq.com"))
                .build();
    }

    private ApiInfo webApiInfo() {

        return new ApiInfoBuilder()
                .title("网站 - 谷粒学院API文档")
                .description("本文档描述了谷粒学院的接口")
                .version("2.0")
                .contact(new Contact("Strive", "http://atguigu.com", "136332183@qq.com"))
                .build();
    }
}

03-分组

1、分为两组：

网站端接口 - 运营系统接口

2、网页前缀分为 “/admin/…” 和 "/api/…"

04-统一返回结果<示例>

一、统一返回数据格式

项目中我们会将响应封装成json返回，一般我们会将所有接口的数据格式统一，使前端对数据的操作更一致、轻松。

一般情况下，统一返回数据格式没有固定的格式，只要能描述清楚返回的数据状态以及要返回的具体数据就可以。但是一般会包含状态码、返回消息、数据这几部分内容

例如，我们的系统要求返回的基本数据格式如下：

列表：

{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "items": [
      {
        "id": "1",
        "name": "刘德华",
        "intro": "毕业于师范大学数学系，热爱教育事业，执教数学思维6年有余"
      }
    ]
  }
}

分页：

{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {
    "total": 17,
    "rows": [
      {
        "id": "1",
        "name": "刘德华",
        "intro": "毕业于师范大学数学系，热爱教育事业，执教数学思维6年有余"
      }
    ]
  }
}

没有返回数据：

{
  "success": true,
  "code": 20000,
  "message": "成功",
  "data": {}
}

失败：

{
  "success": false,
  "code": 20001,
  "message": "失败",
  "data": {}
}

因此，我们定义统一结果

{
  "success": 布尔, //响应是否成功
  "code": 数字, //响应码
  "message": 字符串, //返回消息
  "data": HashMap //返回数据，放在键值对中
}

二、统一返回结果

1、创建返回码定义枚举类

在service-base中

创建包：com.atguigu.guli.service.base.result

创建枚举类： ResultCodeEnum.java

@Getter
@ToString
public enum ResultCodeEnum {
    SUCCESS(true, 20000,"成功"),
    UNKNOWN_REASON(false, 20001, "未知错误"),

    BAD_SQL_GRAMMAR(false, 21001, "sql语法错误"),
    JSON_PARSE_ERROR(false, 21002, "json解析异常"),
    PARAM_ERROR(false, 21003, "参数不正确"),

    FILE_UPLOAD_ERROR(false, 21004, "文件上传错误"),
    FILE_DELETE_ERROR(false, 21005, "文件刪除错误"),
    EXCEL_DATA_IMPORT_ERROR(false, 21006, "Excel数据导入错误"),

    VIDEO_UPLOAD_ALIYUN_ERROR(false, 22001, "视频上传至阿里云失败"),
    VIDEO_UPLOAD_TOMCAT_ERROR(false, 22002, "视频上传至业务服务器失败"),
    VIDEO_DELETE_ALIYUN_ERROR(false, 22003, "阿里云视频文件删除失败"),
    FETCH_VIDEO_UPLOADAUTH_ERROR(false, 22004, "获取上传地址和凭证失败"),
    REFRESH_VIDEO_UPLOADAUTH_ERROR(false, 22005, "刷新上传地址和凭证失败"),
    FETCH_PLAYAUTH_ERROR(false, 22006, "获取播放凭证失败"),

    URL_ENCODE_ERROR(false, 23001, "URL编码失败"),
    ILLEGAL_CALLBACK_REQUEST_ERROR(false, 23002, "非法回调请求"),
    FETCH_ACCESSTOKEN_FAILD(false, 23003, "获取accessToken失败"),
    FETCH_USERINFO_ERROR(false, 23004, "获取用户信息失败"),
    LOGIN_ERROR(false, 23005, "登录失败"),

    COMMENT_EMPTY(false, 24006, "评论内容必须填写"),

    PAY_RUN(false, 25000, "支付中"),
    PAY_UNIFIEDORDER_ERROR(false, 25001, "统一下单错误"),
    PAY_ORDERQUERY_ERROR(false, 25002, "查询支付结果错误"),

    ORDER_EXIST_ERROR(false, 25003, "课程已购买"),

    GATEWAY_ERROR(false, 26000, "服务不能访问"),

    CODE_ERROR(false, 28000, "验证码错误"),

    LOGIN_PHONE_ERROR(false, 28009, "手机号码不正确"),
    LOGIN_MOBILE_ERROR(false, 28001, "账号不正确"),
    LOGIN_PASSWORD_ERROR(false, 28008, "密码不正确"),
    LOGIN_DISABLED_ERROR(false, 28002, "该用户已被禁用"),
    REGISTER_MOBLE_ERROR(false, 28003, "手机号已被注册"),
    LOGIN_AUTH(false, 28004, "需要登录"),
    LOGIN_ACL(false, 28005, "没有权限"),
    SMS_SEND_ERROR(false, 28006, "短信发送失败"),
    SMS_SEND_ERROR_BUSINESS_LIMIT_CONTROL(false, 28007, "短信发送过于频繁");
    private Boolean success;
    private Integer code;
    private String message;
    ResultCodeEnum(Boolean success, Integer code, String message) {
        this.success = success;
        this.code = code;
        this.message = message;
    }
}

2、创建结果类

com.atguigu.guli.service.base.result 中创建类 R.java

@Data
@ApiModel(value = "全局统一返回结果")
public class R {

    @ApiModelProperty(value = "是否成功")
    private Boolean success;

    @ApiModelProperty(value = "返回码")
    private Integer code;

    @ApiModelProperty(value = "返回消息")
    private String message;

    @ApiModelProperty(value = "返回数据")
    private Map<String, Object> data = new HashMap<String, Object>();

    public R(){}

    public static R ok(){
        R r = new R();
        r.setSuccess(ResultCodeEnum.SUCCESS.getSuccess());
        r.setCode(ResultCodeEnum.SUCCESS.getCode());
        r.setMessage(ResultCodeEnum.SUCCESS.getMessage());
        return r;
    }

    public static R error(){
        R r = new R();
        r.setSuccess(ResultCodeEnum.UNKNOWN_REASON.getSuccess());
        r.setCode(ResultCodeEnum.UNKNOWN_REASON.getCode());
        r.setMessage(ResultCodeEnum.UNKNOWN_REASON.getMessage());
        return r;
    }

    public static R setResult(ResultCodeEnum resultCodeEnum){
        R r = new R();
        r.setSuccess(resultCodeEnum.getSuccess());
        r.setCode(resultCodeEnum.getCode());
        r.setMessage(resultCodeEnum.getMessage());
        return r;
    }

    public R success(Boolean success){
        this.setSuccess(success);
        return this;
    }

    public R message(String message){
        this.setMessage(message);
        return this;
    }

    public R code(Integer code){
        this.setCode(code);
        return this;
    }

    public R data(String key, Object value){
        this.data.put(key, value);
        return this;
    }

    public R data(Map<String, Object> map){
        this.setData(map);
        return this;
    }
}

3、修改Controller中的返回结果

修改service-edu的TeacherController

列表

@ApiOperation("所有讲师列表")
@GetMapping("list")
public R listAll(){
    List<Teacher> list = teacherService.list();
    return R.ok().data("items", list).message("获取讲师列表成功");
}

删除

@ApiOperation(value = "根据ID删除讲师", notes = "根据ID删除讲师")
@DeleteMapping("remove/{id}")
public R removeById(@ApiParam(value = "讲师ID", required = true) @PathVariable String id){
    boolean result = teacherService.removeById(id);
    if(result){
        return R.ok().message("删除成功");
    }else{
        return R.error().message("数据不存在");
    }
}

4、重启测试

Stiver_Mr

关注

1
点赞
踩
2

收藏

觉得还不错? 一键收藏
1
评论
谷粒学院-讲师管理接口开发

01-讲师管理接口开发一、启动应用程序1、创建application.yml文件server: port: 8001 # 服务端口spring: profiles: active: dev #环境设置 application: name: service-edu #服务名 datasource: #数据库连接 driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhos
复制链接

扫一扫