基于SpringBoot+Redis的前后端分离外卖项目-苍穹外卖微信小程序端(十三)

た入场券 2024-04-17 10:02 15阅读 0赞

#### 地址簿相关功能 ####

*  1.1 需求分析和设计
 *   *  1.1.1 产品原型
     *  1.1.2 接口设计
     *  1.1.3 表设计
 *  1.2 代码实现
 *   *  1.2.1 Mapper层
     *  1.2.2 Service层
     *  1.2.3 Controller层

## 1.1 需求分析和设计 ##

### 1.1.1 产品原型 ###

地址簿，指的是消费者用户的地址信息，用户登录成功后可以维护自己的地址信息。同一个用户可以有多个地址信息，但是只能有一个**默认地址**。  
![在这里插入图片描述][4418eaafb5b14194898ff8ba0efcacca.png]

对于地址簿管理，有以下几个功能：

*  查询地址列表
 *  新增地址
 *  修改地址
 *  删除地址
 *  设置默认地址
 *  查询默认地址

### 1.1.2 接口设计 ###

根据上述原型图先**粗粒度**设计接口，共包含7个接口。

**接口设计：**

*  新增地址
 *  查询登录用户所有地址
 *  查询默认地址
 *  根据id修改地址
 *  根据id删除地址
 *  根据id查询地址
 *  设置默认地址

接下来**细粒度**分析每个接口，明确每个接口的请求方式、请求路径、传入参数和返回值。

**1). 新增地址**  
![在这里插入图片描述][09226b1648cf4c089d2fc575dfa41d39.png]

**2). 查询登录用户所有地址**

![在这里插入图片描述][2cd6b8051f964b72a97e74c020949b72.png]

**3). 查询默认地址**

![在这里插入图片描述][6d93025eff3345459311dc52ec3068f8.png]

**4). 修改地址**  
![在这里插入图片描述][245f4e8db7d04ffa88d2e3204905ede5.png]  
**5). 根据id删除地址**

![在这里插入图片描述][cea5c1d8b12e492eb1c6f89d1a2ce784.png]

**6). 根据id查询地址**

![在这里插入图片描述][1307bf8e6efa47648fbf836d9e0eb881.png]

**7). 设置默认地址**

![在这里插入图片描述][37d4b80ff23d427aa30af82062147586.png]

### 1.1.3 表设计 ###

用户的地址信息会存储在address\_book表，即地址簿表中。具体表结构如下：

<table> 
 <thead> 
  <tr> 
   <th><strong>字段名</strong></th> 
   <th><strong>数据类型</strong></th> 
   <th><strong>说明</strong></th> 
   <th><strong>备注</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>id</td> 
   <td>bigint</td> 
   <td>主键</td> 
   <td>自增</td> 
  </tr> 
  <tr> 
   <td>user_id</td> 
   <td>bigint</td> 
   <td>用户id</td> 
   <td>逻辑外键</td> 
  </tr> 
  <tr> 
   <td>consignee</td> 
   <td>varchar(50)</td> 
   <td>收货人</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>sex</td> 
   <td>varchar(2)</td> 
   <td>性别</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>phone</td> 
   <td>varchar(11)</td> 
   <td>手机号</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>province_code</td> 
   <td>varchar(12)</td> 
   <td>省份编码</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>province_name</td> 
   <td>varchar(32)</td> 
   <td>省份名称</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>city_code</td> 
   <td>varchar(12)</td> 
   <td>城市编码</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>city_name</td> 
   <td>varchar(32)</td> 
   <td>城市名称</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>district_code</td> 
   <td>varchar(12)</td> 
   <td>区县编码</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>district_name</td> 
   <td>varchar(32)</td> 
   <td>区县名称</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>detail</td> 
   <td>varchar(200)</td> 
   <td>详细地址信息</td> 
   <td>具体到门牌号</td> 
  </tr> 
  <tr> 
   <td>label</td> 
   <td>varchar(100)</td> 
   <td>标签</td> 
   <td>公司、家、学校</td> 
  </tr> 
  <tr> 
   <td>is_default</td> 
   <td>tinyint(1)</td> 
   <td>是否默认地址</td> 
   <td>1是 0否</td> 
  </tr> 
 </tbody> 
</table>

这里面有一个字段is\_default，实际上我们在设置默认地址时，只需要更新这个字段就可以了。

## 1.2 代码实现 ##

### 1.2.1 Mapper层 ###

**创建AddressBookMapper.java**

package com.sky.mapper;
    
    import com.sky.entity.AddressBook;
    import org.apache.ibatis.annotations.*;
    import java.util.List;
    
    @Mapper
    public interface AddressBookMapper {
        
    
        /**
         * 条件查询
         * @param addressBook
         * @return
         */
        List<AddressBook> list(AddressBook addressBook);
    
        /**
         * 新增
         * @param addressBook
         */
        @Insert("insert into address_book" +
                "        (user_id, consignee, phone, sex, province_code, province_name, city_code, city_name, district_code," +
                "         district_name, detail, label, is_default)" +
                "        values (#{userId}, #{consignee}, #{phone}, #{sex}, #{provinceCode}, #{provinceName}, #{cityCode}, #{cityName}," +
                "                #{districtCode}, #{districtName}, #{detail}, #{label}, #{isDefault})")
        void insert(AddressBook addressBook);
    
        /**
         * 根据id查询
         * @param id
         * @return
         */
        @Select("select * from address_book where id = #{id}")
        AddressBook getById(Long id);
    
        /**
         * 根据id修改
         * @param addressBook
         */
        void update(AddressBook addressBook);
    
        /**
         * 根据 用户id修改 是否默认地址
         * @param addressBook
         */
        @Update("update address_book set is_default = #{isDefault} where user_id = #{userId}")
        void updateIsDefaultByUserId(AddressBook addressBook);
    
        /**
         * 根据id删除地址
         * @param id
         */
        @Delete("delete from address_book where id = #{id}")
        void deleteById(Long id);
    
    }

**创建AddressBookMapper.xml**

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
    <mapper namespace="com.sky.mapper.AddressBookMapper">
    
        <select id="list" parameterType="AddressBook" resultType="AddressBook">
            select * from address_book
            <where>
                <if test="userId != null">
                    and user_id = #{userId}
                </if>
                <if test="phone != null">
                    and phone = #{phone}
                </if>
                <if test="isDefault != null">
                    and is_default = #{isDefault}
                </if>
            </where>
        </select>
    
        <update id="update" parameterType="addressBook">
            update address_book
            <set>
                <if test="consignee != null">
                    consignee = #{consignee},
                </if>
                <if test="sex != null">
                    sex = #{sex},
                </if>
                <if test="phone != null">
                    phone = #{phone},
                </if>
                <if test="detail != null">
                    detail = #{detail},
                </if>
                <if test="label != null">
                    label = #{label},
                </if>
                <if test="isDefault != null">
                    is_default = #{isDefault},
                </if>
            </set>
            where id = #{id}
        </update>
    
    </mapper>

### 1.2.2 Service层 ###

**创建AddressBookService.java**

package com.sky.service;
    
    import com.sky.entity.AddressBook;
    import java.util.List;
    
    public interface AddressBookService {
        
    
        List<AddressBook> list(AddressBook addressBook);
    
        void save(AddressBook addressBook);
    
        AddressBook getById(Long id);
    
        void update(AddressBook addressBook);
    
        void setDefault(AddressBook addressBook);
    
        void deleteById(Long id);
    
    }

**创建AddressBookServiceImpl.java**

package com.sky.service.impl;
    
    @Service
    @Slf4j
    public class AddressBookServiceImpl implements AddressBookService {
        
        @Autowired
        private AddressBookMapper addressBookMapper;
    
        /**
         * 条件查询
         *
         * @param addressBook
         * @return
         */
        public List<AddressBook> list(AddressBook addressBook) {
        
            return addressBookMapper.list(addressBook);
        }
    
        /**
         * 新增地址
         *
         * @param addressBook
         */
        public void save(AddressBook addressBook) {
        
            addressBook.setUserId(BaseContext.getCurrentId());
            addressBook.setIsDefault(0);
            addressBookMapper.insert(addressBook);
        }
    
        /**
         * 根据id查询
         *
         * @param id
         * @return
         */
        public AddressBook getById(Long id) {
        
            AddressBook addressBook = addressBookMapper.getById(id);
            return addressBook;
        }
    
        /**
         * 根据id修改地址
         *
         * @param addressBook
         */
        public void update(AddressBook addressBook) {
        
            addressBookMapper.update(addressBook);
        }
    
        /**
         * 设置默认地址
         *
         * @param addressBook
         */
        @Transactional
        public void setDefault(AddressBook addressBook) {
        
            //1、将当前用户的所有地址修改为非默认地址 update address_book set is_default = ? where user_id = ?
            addressBook.setIsDefault(0);
            addressBook.setUserId(BaseContext.getCurrentId());
            addressBookMapper.updateIsDefaultByUserId(addressBook);
    
            //2、将当前地址改为默认地址 update address_book set is_default = ? where id = ?
            addressBook.setIsDefault(1);
            addressBookMapper.update(addressBook);
        }
    
        /**
         * 根据id删除地址
         *
         * @param id
         */
        public void deleteById(Long id) {
        
            addressBookMapper.deleteById(id);
        }
    
    }

### 1.2.3 Controller层 ###

package com.sky.controller.user;
    
    @RestController
    @RequestMapping("/user/addressBook")
    @Api(tags = "C端地址簿接口")
    public class AddressBookController {
        
    
        @Autowired
        private AddressBookService addressBookService;
    
        /**
         * 查询当前登录用户的所有地址信息
         *
         * @return
         */
        @GetMapping("/list")
        @ApiOperation("查询当前登录用户的所有地址信息")
        public Result<List<AddressBook>> list() {
        
            AddressBook addressBook = new AddressBook();
            addressBook.setUserId(BaseContext.getCurrentId());
            List<AddressBook> list = addressBookService.list(addressBook);
            return Result.success(list);
        }
    
        /**
         * 新增地址
         *
         * @param addressBook
         * @return
         */
        @PostMapping
        @ApiOperation("新增地址")
        public Result save(@RequestBody AddressBook addressBook) {
        
            addressBookService.save(addressBook);
            return Result.success();
        }
    
        @GetMapping("/{id}")
        @ApiOperation("根据id查询地址")
        public Result<AddressBook> getById(@PathVariable Long id) {
        
            AddressBook addressBook = addressBookService.getById(id);
            return Result.success(addressBook);
        }
    
        /**
         * 根据id修改地址
         *
         * @param addressBook
         * @return
         */
        @PutMapping
        @ApiOperation("根据id修改地址")
        public Result update(@RequestBody AddressBook addressBook) {
        
            addressBookService.update(addressBook);
            return Result.success();
        }
    
        /**
         * 设置默认地址
         *
         * @param addressBook
         * @return
         */
        @PutMapping("/default")
        @ApiOperation("设置默认地址")
        public Result setDefault(@RequestBody AddressBook addressBook) {
        
            addressBookService.setDefault(addressBook);
            return Result.success();
        }
    
        /**
         * 根据id删除地址
         *
         * @param id
         * @return
         */
        @DeleteMapping
        @ApiOperation("根据id删除地址")
        public Result deleteById(Long id) {
        
            addressBookService.deleteById(id);
            return Result.success();
        }
    
        /**
         * 查询默认地址
         */
        @GetMapping("default")
        @ApiOperation("查询默认地址")
        public Result<AddressBook> getDefault() {
        
            //SQL:select * from address_book where user_id = ? and is_default = 1
            AddressBook addressBook = new AddressBook();
            addressBook.setIsDefault(1);
            addressBook.setUserId(BaseContext.getCurrentId());
            List<AddressBook> list = addressBookService.list(addressBook);
    
            if (list != null && list.size() == 1) {
        
                return Result.success(list.get(0));
            }
    
            return Result.error("没有查询到默认地址");
        }
    
    }

**后记  
👉👉💕💕美好的一天，到此结束，下次继续努力！欲知后续，请看下回分解，写作不易，感谢大家的支持！！ 🌹🌹🌹**

[4418eaafb5b14194898ff8ba0efcacca.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/7ecbfdc458894b4e8e663079b63c8c34.png
[09226b1648cf4c089d2fc575dfa41d39.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/ffdaf99842514859be9e4d23d5fa7163.png
[2cd6b8051f964b72a97e74c020949b72.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/30f71836a0ef4c40994bbb09704560b3.png
[6d93025eff3345459311dc52ec3068f8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/45dd2c32f17d4a848ec2e3480d97ab32.png
[245f4e8db7d04ffa88d2e3204905ede5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/07d5b42ab9ec4f06bae2d6801f817307.png
[cea5c1d8b12e492eb1c6f89d1a2ce784.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/6d8323085b304da4bdde0bc4509a1a24.png
[1307bf8e6efa47648fbf836d9e0eb881.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/dd7efe1c597a48bba96736278cfb621f.png
[37d4b80ff23d427aa30af82062147586.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/f243f4f917e5474d85ad0e307129b7cf.png