【苍穹外卖 | 篇①】项目初结构

原创 已于 2025-11-22 16:32:00 修改 · 638 阅读 · 16 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #intellij-idea #后端 #spring

于 2025-11-14 10:35:56 首次发布

在牛某网看见了牛肉哥的帖子之后，打算向牛肉大佬学习，故开始书写优快云博客，通过博客的方式来巩固自身知识学习。

因为之前有粗略的学习了Java Web的基础课程，所以博客内容主要是巩固之前学习当中的模糊点，以及一些自己认为重要的内容，用于自己进一步的掌握开发技能。

目录

软件开发流程：

软件环境：

开发环境

测试环境

生产环境

技术选型：

应用技术

数据处理：

项目结构：

nginx作用：

nginx反向代理

nginx 负载均衡

完善登录功能：

Swagger：

使用步骤

常用注解：

注：注意Warning！！！！

软件开发流程：

软件环境：

开发环境

在开发阶段使用的环境，就是开发环境，我们可以安装在本地， 也可以安装在专门的服务器中。

测试环境

将项目部署到测试服务器上，这台测试服务器就是就是测试环境，用于项目测试，一般外部用户无法访问。

生产环境

上线项目，将项目部署到线上环境，并正式对外提供服务。

技术选型：

应用技术

SpringBoot： 快速构建Spring项目, 采用 “约定优于配置” 的思想, 简化Spring项目的配置开发。

SpringMVC：SpringMVC是spring框架的模块，springmvc和spring无需通过中间整合层进行整合，可以无缝集成。

Spring Task: 由Spring提供的定时任务框架。

httpclient: 主要实现了对http请求的发送。

Spring Cache: 由Spring提供的数据缓存框架

JWT: 用于对应用程序上的用户进行身份验证的标记。

阿里云OSS: 对象存储服务，主要存储文件，如图片等。

Swagger： 可以自动的帮助开发人员生成接口文档，并对接口进行测试。

POI: 封装了对Excel表格的常用操作。

WebSocket: 一种通信网络协议，使客户端和服务器之间的数据交换更加简单，用于项目的来单、催单功能实现。

数据处理：

MySQL： 关系型数据库, 本项目的核心业务数据都会采用MySQL进行存储。

Redis： 基于key-value格式存储的内存数据库, 访问速度快, 经常使用它做缓存。

Mybatis： 本项目持久层将会使用Mybatis开发。

pagehelper: 分页插件。

spring data redis: 简化java代码操作Redis的API。

项目结构：

序号名称说明
1sky-take-outmaven父工程，统一管理依赖版本，聚合其他子模块
2sky-common子模块，存放公共类，例如：工具类、常量类、异常类等
3sky-pojo子模块，存放实体类、VO、DTO等
4sky-server子模块，后端服务，存放配置文件、Controller、Service、Mapper等
名称说明
Entity实体，通常和数据库中的表对应
DTO数据传输对象，通常用于程序中各层之间传递数据
VO视图对象，为前端展示数据提供的对象
POJO普通Java对象，只有属性和对应的getter和setter
序号表名中文名
1employee员工表
2category分类表
3dish菜品表
4dish_flavor菜品口味表
5setmeal套餐表
6setmeal_dish套餐菜品关系表
7user用户表
8address_book地址表
9shopping_cart购物车表
10orders订单表
11order_detail订单明细表

nginx作用：

前端请求地址与后端接口地址不一致，怎么请求到后端服务呢？

nginx反向代理

nginx 反向代理，就是将前端发送的动态请求由 nginx 转发到后端服务器

nginx 反向代理的好处：

  • 提高访问速度

    nginx可以缓存，如果访问的同一接口，并且做了数据缓存，nginx就直接把数据返回，不需要访问服务端，提高速度。

  • 进行负载均衡

    所谓负载均衡,就是把大量的请求按照指定的方式均衡的分配给集群中的每台服务器。

  • 保证后端服务安全

nginx 反向代理的配置方式：

server{
    listen 80;
    server_name localhost;
    
    location /api/{
        proxy_pass http://localhost:8080/admin/; 
    }
}

proxy_pass：该指令是用来设置代理服务器的地址，可以是主机名称，IP地址加端口号等形式。

如上代码的个人理解是：前端请求80端口，转发到后端的8080端口

nginx 负载均衡

当服务以集群的方式进行部署时，那nginx在转发请求到服务器时就需要做相应的负载均衡。

nginx 负载均衡的配置方式：

upstream webservers{
    server 192.168.100.128:8080;
    server 192.168.100.129:8080;
}
server{
    listen 80;
    server_name localhost;
    
    location /api/{
        proxy_pass http://webservers/admin;#负载均衡
    }
}

upstream：如果代理服务器是一组服务器的话，可以使用upstream指令配置后端服务器组。

根据webservers名称找到一组服务器，根据设置的负载均衡策略转发到具体的服务器。

nginx 负载均衡策略：

名称说明
轮询默认方式
weight权重方式，默认为1，权重越高，被分配的客户端请求就越多
ip_hash依据ip分配方式，这样每个访客可以固定访问一个后端服务
least_conn依据最少连接方式，把请求优先分配给连接数少的后端服务
url_hash依据url分配方式，这样相同的url会被分配到同一个后端服务
fair依据响应时间方式，响应时间短的服务将会被优先分配

具体配置方式：

weight:

upstream webservers{
    server 192.168.100.128:8080 weight=90;
    server 192.168.100.129:8080 weight=10;
}

ip_hash:

upstream webservers{
    ip_hash;
    server 192.168.100.128:8080;
    server 192.168.100.129:8080;
}

least_conn:

upstream webservers{
    least_conn;
    server 192.168.100.128:8080;
    server 192.168.100.129:8080;
}

url_hash:

upstream webservers{
    hash &request_uri;
    server 192.168.100.128:8080;
    server 192.168.100.129:8080;
}

fair:

upstream webservers{
    server 192.168.100.128:8080;
    server 192.168.100.129:8080;
    fair;
}

完善登录功能：

将密码加密后存储，提高安全性

修改Java代码，前端提交的密码进行MD5加密后再跟数据库中密码比对

打开EmployeeServiceImpl.java，修改比对密码


    public Employee login(EmployeeLoginDTO employeeLoginDTO) {

        //.......
        password = DigestUtils.md5DigestAsHex(password.getBytes());

Swagger：

个人认为没什么用，可以用apifox代替，但是都说苍穹外卖需要好好学习，所以还是做好笔记吧。

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

  1. 前后端分离开发

  2. 接口的文档在线自动生成，降低后端开发人员编写接口文档的负担

  3. 功能测试

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!

使用步骤

  1. 导入 knife4j 的maven坐标

    在pom.xml中添加依赖

    <dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-spring-boot-starter</artifactId>
</dependency>

  2. 在配置类中加入 knife4j 相关配置

    WebMvcConfiguration.java

    /**
     * 通过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;
    }

  3. 设置静态资源映射，否则接口文档页面无法访问

    WebMvcConfiguration.java

    /**
     * 设置静态资源映射
     * @param registry
*/
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}

  4. 访问测试

    接口文档访问路径为 http://ip:port/doc.html —> http://localhost:8080/doc.html

  5. 测试登录功能

常用注解：

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

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

在sky-pojo模块中

EmployeeLoginDTO.java

package com.sky.dto;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.io.Serializable;

@Data
@ApiModel(description = "员工登录时传递的数据模型")
public class EmployeeLoginDTO implements Serializable {

    @ApiModelProperty("用户名")
    private String username;

    @ApiModelProperty("密码")
    private String password;

}

EmployeeLoginVo.java

package com.sky.vo;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(description = "员工登录返回的数据格式")
public class EmployeeLoginVO implements Serializable {

    @ApiModelProperty("主键值")
    private Long id;

    @ApiModelProperty("用户名")
    private String userName;

    @ApiModelProperty("姓名")
    private String name;

    @ApiModelProperty("jwt令牌")
    private String token;

}

在sky-server模块中

EmployeeController.java

package com.sky.controller.admin;

import com.sky.constant.JwtClaimsConstant;
import com.sky.dto.EmployeeLoginDTO;
import com.sky.entity.Employee;
import com.sky.properties.JwtProperties;
import com.sky.result.Result;
import com.sky.service.EmployeeService;
import com.sky.utils.JwtUtil;
import com.sky.vo.EmployeeLoginVO;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

/**
 * 员工管理
 */
@RestController
@RequestMapping("/admin/employee")
@Slf4j
@Api(tags = "员工相关接口")
public class EmployeeController {

    @Autowired
    private EmployeeService employeeService;
    @Autowired
    private JwtProperties jwtProperties;

    /**
     * 登录
     *
     * @param employeeLoginDTO
     * @return
     */
    @PostMapping("/login")
    @ApiOperation(value = "员工登录")
    public Result<EmployeeLoginVO> login(@RequestBody EmployeeLoginDTO employeeLoginDTO) 	{
        //..............

        
    }

    /**
     * 退出
     *
     * @return
     */
    @PostMapping("/logout")
    @ApiOperation("员工退出")
    public Result<String> logout() {
        return Result.success();
    }

}

注：注意Warning！！！！

本篇主要是观看视频时认为重要需要记下的内容，之后再发一篇文章，用于记下熟悉初始代码中的重要点

GCj1024
关注
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值