揭秘外卖项目中的地址簿接口设计与实现

后端

2023-09-18 15:58:20

外卖平台地址簿接口设计与实现：优化用户体验的秘诀

简介

随着外卖行业的蓬勃发展，外卖平台之间的竞争也日益激烈。为了吸引和留住用户，打造一款具有优势明显、用户体验流畅的外卖小程序至关重要。而地址簿接口的设计与实现，正是影响用户体验的关键所在。

地址簿接口

地址簿接口是管理用户收货地址信息的接口，它主要用于：

新增、删除、修改用户地址
查询用户地址列表
设置和获取默认地址
验证地址有效性

整体架构

地址簿接口的整体架构如下图所示：

[外卖项目地址簿接口整体架构图]

接口设计

地址簿接口共包含 7 个接口，每个接口的请求方式、请求路径、传入参数和返回值如下表所示：

接口	请求方式	请求路径	传入参数	返回值
新增地址	POST	/address/add	用户地址信息	地址信息
删除地址	DELETE	/address/delete	地址 ID	成功/失败
修改地址	PUT	/address/update	地址 ID、地址信息	地址信息
查询地址列表	GET	/address/list	用户 ID	地址列表
设置默认地址	PUT	/address/set_default	地址 ID	成功/失败
获取默认地址	GET	/address/get_default	用户 ID	地址信息
验证地址	POST	/address/verify	地址信息	验证结果

数据结构

地址簿表（address_book）

字段	类型	约束	说明
id	int	主键	地址 ID
user_id	int	外键	用户 ID
name	varchar(20)	非空	收货人姓名
phone	varchar(11)	非空	收货人电话
province	varchar(20)	非空	省份
city	varchar(20)	非空	城市
district	varchar(20)	非空	区县
address	varchar(100)	非空	详细地址
is_default	tinyint(1)	默认 0	是否为默认地址（0：否，1：是）

接口实现

以新增地址接口为例，其实现代码如下：

@PostMapping("/add")
public Result<Address> add(@RequestBody Address address) {
    // 参数校验
    if (address == null) {
        return Result.error("参数不能为空");
    }
    if (address.getUserId() == null) {
        return Result.error("用户 ID 不能为空");
    }
    if (address.getName() == null || address.getName().isEmpty()) {
        return Result.error("收货人姓名不能为空");
    }
    if (address.getPhone() == null || address.getPhone().isEmpty()) {
        return Result.error("收货人电话不能为空");
    }
    if (address.getProvince() == null || address.getProvince().isEmpty()) {
        return Result.error("省份不能为空");
    }
    if (address.getCity() == null || address.getCity().isEmpty()) {
        return Result.error("城市不能为空");
    }
    if (address.getDistrict() == null || address.getDistrict().isEmpty()) {
        return Result.error("区县不能为空");
    }
    if (address.getAddress() == null || address.getAddress().isEmpty()) {
        return Result.error("详细地址不能为空");
    }

    // 设置默认地址
    if (address.getIsDefault() == null || address.getIsDefault() == 0) {
        address.setIsDefault(0);
    } else {
        // 将其他地址的默认地址设置为 0
        addressBookService.setDefaultAddress(address.getUserId(), 0);
    }

    // 保存地址
    addressBookService.save(address);

    // 返回结果
    return Result.success(address);
}