黑马 --- 苍穹外卖Day01

日落于西方OvO

已于 2024-03-06 08:14:58 修改

阅读量422

点赞数 4

分类专栏：项目文章标签： springboot java

于 2024-03-05 19:06:05 首次发布

本文链接：https://blog.csdn.net/m0_68873151/article/details/136363716

版权

项目专栏收录该内容

5 篇文章 0 订阅

订阅专栏

一、项目介绍

在这里插入图片描述

二、后端项目结构

在这里插入图片描述

Git版本管理

在本地创建本地Git仓库
在Gitee上创建远程仓库
把本地文件推送到远程仓库

数据库

在这里插入图片描述

nginx反向代理、负载均衡的配置方式

在这里插入图片描述

完善登录功能（密码采用MD5加密）

在这里插入图片描述

Swagger

在这里插入图片描述

package com.sky.config;

import com.sky.interceptor.JwtTokenAdminInterceptor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * 配置类，注册web层相关组件
 */
@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {
    /**
     * 通过knife4j生成接口文档
     * @return
     */
    @Bean
    public Docket docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("苍穹外卖项目接口文档")
                .version("2.0")
                .description("苍穹外卖项目接口文档")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                // 指定生成接口需要扫描的包（最重要的一句话）
                .apis(RequestHandlerSelectors.basePackage("com.sky.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

    /**
     * 设置静态资源映射
     * @param registry
     */
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
    	// 如果不写以下两句，那么当访问 doc.html时，程序会认为我们在访问某个Controller从而导致404错误
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

常用注解

通过注解可以控制生成的接口文档，使接口文档拥有更好的可读性，常用注解如下：

注解	说明
@Api	用在类上，如Controller类，表示对类的说明
@ApiModel	用在类上，如entity、dto、vo
@ApiModelProperty	用在属性上，描述属性信息
@ApiOperation	用在方法上，如Controller中的方法，说明该方法的用途、作用