乐优商城（三十五）——订单微服务

最新推荐文章于 2024-05-08 19:05:32 发布
最新推荐文章于 2024-05-08 19:05:32 发布
阅读量2.8k 收藏 5
点赞数
分类专栏： 乐优商城
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lyj2018gyq/article/details/83444186
版权

目录

一、订单系统接口

1.1 Swagger-UI

1.1.1 什么是OpenApi

1.1.2 什么是Swagger

1.1.3 快速入门

1.2 测试接口

1.2.1 创建订单接口

1.2.2 生成ID方式

1.2.3 查询订单接口

1.2.4 更新订单状态

1.2.5 分页查询订单

1.2.6 生成微信付款链接

1.2.7 查询支付状态

一、订单系统接口

1.1 Swagger-UI

1.1.1 什么是OpenApi

随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、前后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。  前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要。

没有API文档工具之前，大家都是手写API文档的，在什么地方书写的都有，而且API文档没有统一规范和格式，每个公司都不一样。这无疑给开发带来了灾难。

OpenAPI规范（OpenAPI Specification 简称OAS）是Linux基金会的一个项目，试图通过定义一种用来描述API格式或API定义的语言，来规范RESTful服务开发过程。目前V3.0版本的OpenAPI规范已经发布并开源在github上 。

官网：https://github.com/OAI/OpenAPI-Specification

1.1.2 什么是Swagger

OpenAPI是一个编写API文档的规范，然而如果手动去编写OpenAPI规范的文档，是非常麻烦的。而Swagger就是一个实现了OpenAPI规范的工具集。

官网：https://swagger.io/

官方的说明：

Swagger包含的工具集：

  • Swagger编辑器： Swagger Editor允许您在浏览器中编辑YAML中的OpenAPI规范并实时预览文档。

  • Swagger UI： Swagger UI是HTML，Javascript和CSS资产的集合，可以从符合OAS标准的API动态生成漂亮的文档。

  • Swagger Codegen：允许根据OpenAPI规范自动生成API客户端库（SDK生成），服务器存根和文档。

  • Swagger Parser：用于解析来自Java的OpenAPI定义的独立库

  • Swagger Core：与Java相关的库，用于创建，使用和使用OpenAPI定义

  • Swagger Inspector（免费）： API测试工具，可让您验证您的API并从现有API生成OpenAPI定义

  • SwaggerHub（免费和商业）： API设计和文档，为使用OpenAPI的团队构建。

1.1.3 快速入门

SpringBoot已经集成了Swagger，使用简单注解即可生成swagger的API文档。

引入依赖

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

编写配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .host("http://order.leyou.com")
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.leyou.order.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("乐优商城订单系统")
                .description("乐优商城订单系统接口文档")
                .version("1.0")
                .build();
    }
}

接口声明

在controller的每个handler上添加接口说明注解：

package com.leyou.order.controller;

import com.leyou.common.pojo.PageResult;
import com.leyou.order.pojo.Order;
import com.leyou.order.service.OrderService;
import com.leyou.order.utils.PayHelper;
import com.leyou.order.utils.PayState;
import io.swagger.annotations.*;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import javax.validation.Valid;

/**
 * @Author: 98050
 * @Time: 2018-10-27 16:30
 * @Feature: 订单Controller
 */
@RestController
@Api("订单服务接口")
public class OrderController {

    @Autowired
    private OrderService orderService;

    @Autowired
    private PayHelper payHelper;

    /**
     * 创建订单
     * @param order 订单对象
     * @return 订单编号
     */
    @PostMapping
    @ApiOperation(value = "创建订单接口，返回订单编号",notes = "创建订单")
    @ApiImplicitParam(name = "order",required = true,value = "订单的json对象，包含订单条目和物流信息")
    public ResponseEntity<Long> createOrder(@RequestBody @Valid Order order){
        Long id = this.orderService.createOrder(order);
        return new ResponseEntity<>(id, HttpStatus.CREATED);
    }

    /**
     * 查询订单
     * @param id 订单编号
     * @return 订单对象
     */
    @ApiOperation(value = "根据订单编号查询订单，返回订单对象",notes = "查询订单")
    @ApiImplicitParam(name = "id",required = true,value = "订单编号")
    @GetMapping("{id}")
    public ResponseEntity<Order> queryOrderById(@PathVariable("id") Long id){
        Order order = this.orderService.queryOrderById(id);
        if (order == null){
            return ResponseEntity.status(HttpStatus.NOT_FOUND).build();
        }
        return ResponseEntity.ok(order);
    }

    /**
     * 分页查询当前已经登录的用户订单
     * @param page 页数
     * @param rows 每页大小
     * @param status 订单状态
     * @return
     */
    @GetMapping("list")
    @ApiOperation(value = "分页查询当前用户订单，并且可以根据订单状态过滤",notes = "分页查询当前用户订单")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "page",value = "当前页",defaultValue = "1",type = "Integer"),
            @ApiImplicitParam(name = "rows",value = "每页大小",defaultValue = "5",type = "Integer"),
            @ApiImplicitParam(name = "status",value = "订单状态：1未付款，" +
                    "2已付款未发货，" +
                    "3已发货未确认，" +
                    "4已确认未评价，" +
                    "5交易关闭，" +
                    "6交易成功，已评价",defaultValue = "1",type = "Integer")
    })
    @ApiResponses({
            @ApiResponse(code = 200, message = "订单的分页结果"),
            @ApiResponse(code = 404, message = "没有查询到结果"),
            @ApiResponse(code = 500,message = "服务器异常")
    })
    public ResponseEntity<PageResult<Order>> queryUserOrderList(
            @RequestParam(value = "page",defaultValue = "1")Integer page,
            @RequestParam(value = "rows",defaultValue = "5")Integer rows,
            @RequestParam(value = "status",required = false)Integer status
    ){

        PageResult<Order> result = this.orderService.queryUserOrderList(page,rows,status);
        if (result == null){
            return new ResponseEntity<>(HttpStatus.NOT_FOUND);
        }
        return ResponseEntity.ok(result);
    }


    /**
     * 更新订单状态
     * @param id
     * @param status
     * @return
     */
    @PutMapping("{id}/{status}")
    @ApiOperation(value = "更新订单状态",notes = "更新订单状态")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id",value = "订单编号",type = "Long"),
            @ApiImplicitParam(name = "status",value = "订单状态：1未付款，" +
                    "2已付款未发货，" +
                    "3已发货未确认，" +
                    "4已确认未评价，" +
                    "5交易关闭，" +
                    "6交易成功，已评价",defaultValue = "1",type = "Integer")
    })
    @ApiResponses({
            @ApiResponse(code = 204,message = "true:修改成功；false:修改状态失败"),
            @ApiResponse(code = 400,message = "请求参数有误"),
            @ApiResponse(code = 500,message = "服务器异常")
    })
    public ResponseEntity<Boolean> updateOrderStatus(@PathVariable("id") Long id,@PathVariable("status") Integer status){
        Boolean result = this.orderService.updateOrderStatus(id,status);
        if (result == null){
            //返回400
            return new ResponseEntity<>(HttpStatus.BAD_REQUEST);
        }
        //返回204
        return new ResponseEntity<>(result,HttpStatus.NO_CONTENT);
    }

    /**
     * 根据订单id生成付款链接
     * @param orderId
     * @return
     */
    @GetMapping("url/{id}")
    @ApiOperation(value = "生成微信扫描支付付款链接",notes = "生成付款链接")
    @ApiImplicitParam(name = "id",value = "订单编号",type = "Long")
    @ApiResponses({
            @ApiResponse(code = 200,message = "根据订单编号生成的微信支付地址"),
            @ApiResponse(code = 404,message = "生成链接失败"),
            @ApiResponse(code = 500,message = "服务器异常")
    })
    public ResponseEntity<String> generateUrl(@PathVariable("id") Long orderId){
        String url = this.payHelper.createPayUrl(orderId);
        if (StringUtils.isNotBlank(url)){
            return ResponseEntity.ok(url);
        }else {
            return ResponseEntity.status(HttpStatus.NOT_FOUND).build();
        }
    }

    /**
     * 查询付款状态
     * @param orderId
     * @return
     */
    @GetMapping("state/{id}")
    @ApiOperation(value = "查询扫码支付的付款状态",notes = "查询付款状态")
    @ApiImplicitParam(name = "id",value = "订单编号",type = "Long")
    @ApiResponses({
            @ApiResponse(code = 200, message = "0, 未查询到支付信息 1,支付成功 2,支付失败"),
            @ApiResponse(code = 500, message = "服务器异常"),
    })
    public ResponseEntity<Integer> queryPayState(@PathVariable("id") Long orderId){
        PayState payState = this.payHelper.queryOrder(orderId);
        return ResponseEntity.ok(payState.getValue());
    }


}

常用注解说明：

/**
 @Api：修饰整个类，描述Controller的作用
 @ApiOperation：描述一个类的一个方法，或者说一个接口
 @ApiParam：单个参数描述
 @ApiModel：用对象来接收参数
 @ApiProperty：用对象接收参数时，描述对象的一个字段
 @ApiResponse：HTTP响应其中1个描述
 @ApiResponses：HTTP响应整体描述
 @ApiIgnore：使用该注解忽略这个API
 @ApiError ：发生错误返回的信息
 @ApiImplicitParam：一个请求参数
 @ApiImplicitParams：多个请求参数
 */

启动测试

启动服务，然后访问：http://localhost:8089/swagger-ui.html

访问过程中遇到到错误请参考：《坑》

点击order-controller，查看接口信息

点击任意一个接口，即可查看详细信息：

1.2 测试接口

1.2.1 创建订单接口

可以通过页面看到接口信息：

  • 请求方式：POST

  • 请求路径：/order

  • 请求参数：包含订单、订单详情等数据的json对象。

  • 返回结果：订单编号

点击Try It Out来测试

填入数据

{
  "totalPay": 236800,
  "postFee": 0,
  "paymentType": 2,
  "actualPay": 236800,
  "buyerMessage": null,
  "buyerNick": "huge",
  "orderDetails": [
    {
      "skuId": 3893493,
      "num": 1,
      "title": "苹果（Apple）iPhone 6 (A1586) 16GB 金色 移动联通电信4G手机3",
      "price": 236800,
      "ownSpec": "{\"机身颜色\":\"钻雕蓝\",\"内存\":\"4GB\",\"机身存储\":\"64GB\"}",
      "image": "http://image.leyou.com/images/9/4/1524297342728.jpg"
    }
  ],
  "receiver": "锋哥",
  "receiverMobile": "15800000000",
  "receiverState": "上海",
  "receiverCity": "上海",
  "receiverDistrict": "浦东新签",
  "receiverAddress": "航头镇航头路18号传智播客3号楼",
  "receiverZip": "210000",
  "invoiceType": 0,
  "sourceType":2
}

点击Execute

查看返回结果

401 未授权，因为下订单需要用户登录，所以要携带token。

通过登录生成token

把token的值手动加入到浏览器的cookie中

再次执行

添加成功，响应订单编号。

1.2.2 生成ID方式

请参考：《分布式自增id》

1.2.3 查询订单接口

接口说明

  • 请求方式：GET

  • 请求路径：/order/{id}

  • 请求参数：id，订单编号

  • 返回结果：Order，订单的json对象

测试

输入刚才生成的订单号：

结果：

1.2.4 更新订单状态

接口说明

  • 请求参数：PUT

  • 请求路径：/order/{id}/{status}

  • 请求参数：

    • id：订单编号，String类型，不能为空

    • status：订单状态，不能为空

  • 返回结果：null

测试

数据库中的数据：

修改：

结果：

数据库：

1.2.5 分页查询订单

接口说明

  • 请求方式：Get

  • 请求路径：/order/list

  • 请求参数：

    • page：当前页，Integer类型，默认为1

    • rows：每页大小，Integer类型，默认为5

    • status：订单状态，String类型，默认查询全部状态订单

  • 返回结果：PageResult 对象，包含下面属性：

    • total：总条数

    • items：当前页订单数组

      • 订单对象

测试

结果：

改造一下分页代码

 

1.2.6 生成微信付款链接

接口说明

  • 请求方式：Get

  • 请求路径：/order/url/{id}

  • 请求参数：id，订单编号

  • 返回结果：String类型，生成的微信支付链接

测试

结果：

微信支付工具

1.2.7 查询支付状态

接口说明

  • 请求方式： Get

  • 请求路径： /state/{id}

  • 请求参数： id，订单编号

  • 返回结果：0, 未查询到支付信息 1,支付成功 2,支付失败（查询失败，或者订单过期）

未付款

未付款时查询，测试：

结果：

付款

已付款

飘来荡去、、
关注
  • 0
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
乐优商城：笔记（十五）：订单微服务：LyOrderApplication
dianemax
06-09 1738
文章目录1 创建订单微服务1.1 分析1.2 服务搭建1.2.1 创建module1.2.2 引入依赖1.2.3 配置文件1.2.4 启动类1.2.5 配置路由1.2.6 其他配置2 订单结算页2.1 数据结构2.2 实体类2.2 提交订单2.2.1 接口分析2.2.2 mapper2.2.3 controller2.2.4 service 1 创建订单微服务 1.1 分析 当我们在购物车种选择好...
乐优商城订单微服务配置
10-27
乐优商城订单微服务是基于微服务架构设计的电商系统中的一个重要组成部分，主要负责处理与订单相关的业务逻辑。在微服务架构中，每个微服务都是一个独立的单元，可以独立部署、扩展和更新，以提高系统的可伸缩性和...
乐优商城（三十八）——订单微服务
lyj2018gyq的博客
10-30 1969
目录 五、地址管理 5.1 页面效果 5.2数据库表设计 5.3页面优化 5.3.1 在data中定义数据 5.3.2 模态框 5.3.3方法绑定 5.3.4 效果展示 5.4后台接口 5.4.1 实体类 5.4.2 Controller 5.4.3 Mapper 5.4.4 Service 5.5 接口测试 5.5.1 新增地址 5.5.2 查询地址 5...
2024年海量订单系统微服务开发：订单接口管理后台微服务开发、集成测试，2024年最新程序员必学
最新发布
2401_84715732的博客
05-08 698
这里我们监听了消息队列“ordermsg.update”，将接收的消息转换成查询对象OrderQo，这样，即可根据订单状态和订单明细中的商品数据，决定是否执行商品库存存量减少的操作，完成一次分布式事务管理的整个流程。微服务的多服务架构，使得数据可以由不同的微服务进行分散管理，所以想要保证数据的一致性，就必须有合理的设计。比如当买家撤销订单时，库存服务的商品存量必须改变。注意，这里的消息队列的名称设定为“ordermsg.update”，所以，消息接收方必须使用这个队列名称才能接收订单状态变化的相关信息。
乐优商城（三十六）——订单微服务
lyj2018gyq的博客
10-29 4281
目录 二、订单结算页 2.1 页面跳转 2.2 收货人信息 2.3 支付方式 2.4 商品列表 2.4.1 购物车信息获取 2.4.2 页面渲染 2.5 总金额 2.6 提交订单 2.6.1 页面提交 2.6.2 精度损失问题 三、微信支付 3.1 介绍 3.2 开发流程 3.2.1 介绍 3.2.2 具体工作 3.3 生成二维码 3.3.1 生成预交易链接 ...
乐优商城（三十七）——订单微服务
lyj2018gyq的博客
10-29 1628
目录 四、细节优化 4.1 支付页面显示总金额 4.1.1 支付页面 4.1.2 支付成功页面 4.2 修改订单号的传递方式 4.2.1 修改订单提交函数 4.2.2 修改支付页面 4.3 订单提交时进行登录认证 4.4 本地数据删除 4.5 购物车数据更新 4.5.1 Controller 4.5.2 Service 4.5.3 测试 4.5.4 页面处理 四、细节...
乐优商城（三十四）——订单微服务
lyj2018gyq的博客
10-27 3873
目录 一、创建订单微服务 1.1 创建module 1.2 pom依赖 1.3 配置文件 1.4 启动类 1.5 配置导入 1.6 属性读取 1.7 支付工具类 1.8 修改网关配置 二、实体类准备 2.1 Order.java 2.2 OrderDetail.java 2.3 OrderStatus.java 2.4 关系 三、Mapper 四、创建订单 4.1...
【javaWeb微服务架构项目——乐优商城day15】——会调用订单系统接口，实现订单结算功能，实现微信支付功能
qq_38454176的博客
04-09 1766
0.学习目标 会调用订单系统接口 实现订单结算功能 实现微信支付功能 源码笔记及资料： 链接：https://pan.baidu.com/s/1_opfL63P1pzH3rzLnbFiNw 提取码：voqh 1.订单系统接口 我们不做开发，只讲解 1.1.导入订单服务 把课前资料提供的leyou-order复制到D:\heima\code\leyou目录。 然后在工程内导入： 然后导入mod...
【javaWeb微服务架构项目——乐优商城day01】——乐优商城介绍，项目搭建，ES6语法指南
qq_38454176的博客
03-16 1616
0.学习目标 了解电商行业 了解乐优商城项目结构 能独立搭建项目基本框架 能参考使用ES6的新语法 1.了解电商行业 学习电商项目，自然要先了解这个行业，所以我们首先来聊聊电商行业 1.1.项目分类 主要从需求方、盈利模式、技术侧重点这三个方面来看它们的不同 1.1.1.传统项目 各种企业里面用的管理系统（ERP、HR、OA、CRM、物流管理系统。。。。。。。） 需求方：公司、企业内部 盈利...
【javaWeb微服务架构项目——乐优商城day07】——Elasticsearch介绍和安装及使用（安装kibana，安装ik分词器，Spring Data Elasticsearch，高级查询）
qq_38454176的博客
03-29 664
0.学习目标 独立安装Elasticsearch 会使用Rest的API操作索引 会使用Rest的API查询数据 会使用Rest的API聚合数据 掌握Spring Data Elasticsearch使用 1.Elasticsearch介绍和安装 用户访问我们的首页，一般都会直接搜索来寻找自己想要购买的商品。 而商品的数量非常多，而且分类繁杂。如何能正确的显示出用户想要的商品，并进行合理的过滤...
【javaWeb微服务架构项目——乐优商城day12】——实现数据校验功能，实现短信发送功能，实现注册功能，实现根据用户名和密码查询用户功能
qq_38454176的博客
04-07 880
文章目录0.学习目标1.创建用户中心1.1.创建父module1.2.创建leyou-user-interface1.3.创建leyou-user-service1.4.添加网关路由2.后台功能准备2.1.接口文档2.2.数据结构2.3.基本代码2.3.1.实体类2.3.2.mapper2.3.3.Service2.3.4.controller3.数据验证功能3.1.接口说明3.2.control...
黑马java微服务项目乐优商城全套网盘链接
02-22
黑马java微服务项目乐优商城全套网盘链接。 黑马java微服务项目乐优商城全套网盘链接。 乐优商城的英文一个全品类的电商购物网站（B2C）。 用户可以在线购买商品，加入购物车，下单，商品秒杀 可以品论已社群中心...
乐优商城订单微服务属性配置类
10-27
在这个场景下，“乐优商城订单微服务属性配置类”是实现订单处理微服务的核心配置模块。这个配置类主要用于定义和管理订单微服务运行所需的各种属性，确保服务能够正确地与其他系统交互并执行其职责。 首先，我们要...
黑马微服务项目 乐优商城网盘下载地址
02-13
乐优商城的英文一个全品类的电商购物网站（B2C）。 用户可以在线购买商品，加入购物车，下单，商品秒杀 可以品论已社群中心商品 管理员可以在后台管理商品的上下游架，活动促销 管理员可以监控点商品销售状况 客服...
基于SpringCloud的微服务乐优商城
04-10
"基于SpringCloud的微服务乐优商城"是一个具体的应用实例，它将这些理论应用于实际的B2C电商平台，旨在提供一个全面的购物体验。 首先，让我们深入理解Spring Cloud的核心组件： 1. **Eureka**：它是服务注册与...
乐优商城（一）项目介绍
热门推荐
lyj2018gyq的博客
08-23 5万+
GitHub：https://github.com/lyj8330328 目录 一，项目介绍 二，系统架构 2.1架构图 2.2架构图介绍 三，项目搭建 3.1技术选型 3.2域名 3.3后台管理系统搭建 3.3.1代码 3.3.2安装依赖 3.3.3运行测试 3.3.4项目结构 3.4前台门户搭建（暂略） 3.5服务搭建 ...
乐优商城最终篇
lyj2018gyq的博客
12-12 1万+
目录 一、总结 1.1 架构图 1.2 包含的微服务 1.2.1 网关微服务 1.2.2 授权中心微服务 1.2.3 购物车微服务 1.2.4 评论微服务（新增） 1.2.5 配置中心微服务 1.2.6 页面详情微服务 1.2.7 后台管理微服务 1.2.8 订单微服务 1.2.9 Eureak注册中心 1.2.10 搜索微服务 1.2.11 秒杀微服务（新增） 1....
乐优商城（三）商品分类管理
lyj2018gyq的博客
08-28 1万+
目录 一、数据 二、页面实现 2.1 页面分析 2.2 功能实现 2.2.1 url异步请求 2.2.2 后台接口实现 2.3 解决跨域请求 2.3.1 什么是跨域 2.3.2 解决跨域问题的方案 2.3.3 cors解决跨域问题 2.3.4 重新测试 2.4 功能完善 2.4.1 异步查询工具axios 2.4.2 QS工具 2.4.3 增加分类 2.4.4 删除...
"基于B/S结构的乐优购物商城开发技术与功能分析论文
《乐优购物商城》是一篇毕业论文的题目，该论文主要通过对乐优购物商城的开发与设计展开研究。本文通过摘要、背景意义、论文结构安排、开发技术介绍、需求分析、可行性分析、功能分析、业务流程分析、数据库设计、ER...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值