【SpringBoot + Vue 尚庭公寓实战】房间支付方式管理接口实现（三）
文章目录
- 【SpringBoot + Vue 尚庭公寓实战】房间支付方式管理接口实现（三）
- 1、查询全部支付方式列表
- 2、保存或更新支付方式
- 3、根据ID删除支付方式
房间支付方式管理共有三个接口，分别是：
查询全部支付方式列表
保存或更新支付方式
根据ID删除支付方式
首先在PaymentTypeController中注入PaymentTypeService依赖，如下
@Tag(name = "支付方式管理")
@RequestMapping("/admin/payment")
@RestController
public class PaymentTypeController {
@Autowired
private PaymentTypeService service;
}
1、查询全部支付方式列表
查看接口，运行项目后，访问localhost:8080/doc.html
点击支付方式管理
再点击查询全部支付方式列表接口
//响应实例
{
"code": 0,
"message": "",
"data": [
{
"id": 0,
"name": "",
"payMonthCount": "",
"additionalInfo": ""
}
]
}
进行开发
1、在com/atguigu/lease/web/admin/controller/apartment/PaymentTypeController.java创建listPaymentType()方法
@Operation(summary = "查询全部支付方式列表")
@GetMapping("list")
public Result<List<PaymentType>> listPaymentType() {
List<PaymentType> list = service.list();
return Result.ok(list);
}
2、查看service层
/**
* @author liubo
* @description 针对表【payment_type(支付方式表)】的数据库操作Service
* @createDate 2023-07-24 15:48:00
*/
public interface PaymentTypeService extends IService<PaymentType> {
}
3、查看service实现类
/**
* @author liubo
* @description 针对表【payment_type(支付方式表)】的数据库操作Service实现
* @createDate 2023-07-24 15:48:00
*/
@Service
public class PaymentTypeServiceImpl extends ServiceImpl<PaymentTypeMapper, PaymentType>
implements PaymentTypeService{
}
4、查看Mapper
/**
* @author liubo
* @description 针对表【payment_type(支付方式表)】的数据库操作Mapper
* @createDate 2023-07-24 15:48:00
* @Entity com.atguigu.lease.model.PaymentType
*/
public interface PaymentTypeMapper extends BaseMapper<PaymentType> {
}
因为使用的是mybatisplus，这意味着它将拥有BaseMapper接口中定义的所有通用CRUD方法，这些方法可以直接用于对PaymentType实体对应的数据库表进行操作，service层也同理。
知识点：
-
逻辑删除功能
由于数据库中所有表均采用逻辑删除策略，所以查询数据时均需要增加过滤条件
is_deleted=0。上述操作虽不难实现，但是每个查询接口都要考虑到，也显得有些繁琐。为简化上述操作，可以使用Mybatis-Plus提供的逻辑删除功能，它可以自动为查询操作增加
is_deleted=0过滤条件，并将删除操作转为更新语句。具体配置如下，详细信息可参考官方文档。-
步骤一：在
application.yml中增加如下内容mybatis-plus: global-config: db-config: logic-delete-field: flag # 全局逻辑删除的实体字段名(配置后可以忽略不配置步骤二) logic-delete-value: 1 # 逻辑已删除值(默认为 1) logic-not-delete-value: 0 # 逻辑未删除值(默认为 0) -
步骤二：在实体类中的删除标识字段上增加
@TableLogic注解@Data public class BaseEntity { @Schema(description = "主键") @TableId(value = "id", type = IdType.AUTO) private Long id; @Schema(description = "创建时间") @JsonIgnore private Date createTime; @Schema(description = "更新时间") @JsonIgnore private Date updateTime; @Schema(description = "逻辑删除") @JsonIgnore @TableLogic @TableField("is_deleted") private Byte isDeleted; }注意：
逻辑删除功能只对Mybatis-Plus自动注入的sql起效，也就是说，对于手动在
Mapper.xml文件配置的sql不会生效，需要单独考虑。
-
2、保存或更新支付方式
查看接口，运行项目后，访问localhost:8080/doc.html
点击支付方式管理
再点击保存或更新支付方式
//请求示例
{
"id": 0,
"name": "",
"payMonthCount": "",
"additionalInfo": ""
}
//响应示例
{
"code": 0,
"message": "",
"data": {}
}
进行开发
在PaymentTypeController中增加如下内容
@Operation(summary = "保存或更新支付方式")
@PostMapping("saveOrUpdate")
public Result saveOrUpdatePaymentType(@RequestBody PaymentType paymentType) {
service.saveOrUpdate(paymentType);
return Result.ok();
}
知识点：
保存或更新数据时，前端通常不会传入isDeleted、createTime、updateTime这三个字段，因此我们需要手动赋值。但是数据库中几乎每张表都有上述字段，所以手动去赋值就显得有些繁琐。为简化上述操作，我们可采取以下措施。
-
is_deleted字段：可将数据库中该字段的默认值设置为0。 -
create_time和update_time：可使用mybatis-plus的自动填充功能，所谓自动填充，就是通过统一配置，在插入或更新数据时，自动为某些字段赋值，具体配置如下，详细信息可参考官方文档。-
为相关字段配置触发填充的时机，例如
create_time需要在插入数据时填充，而update_time需要在更新数据时填充。具体配置如下，观察@TableField注解中的fill属性。@Data public class BaseEntity { @Schema(description = "主键") @TableId(value = "id", type = IdType.AUTO) private Long id; @Schema(description = "创建时间") @JsonIgnore @TableField(value = "create_time", fill = FieldFill.INSERT) private Date createTime; @Schema(description = "更新时间") @JsonIgnore @TableField(value = "update_time", fill = FieldFill.UPDATE) private Date updateTime; @Schema(description = "逻辑删除") @JsonIgnore @TableLogic @TableField("is_deleted") private Byte isDeleted; } -
配置自动填充的内容，具体配置如下
-
-
在common模块下创建
com.atguigu.lease.common.mybatisplus.MybatisMetaObjectHandler类，内容如下：@Component public class MybatisMetaObjectHandler implements MetaObjectHandler { @Override public void insertFill(MetaObject metaObject) { this.strictInsertFill(metaObject, "createTime", Date.class, new Date()); } @Override public void updateFill(MetaObject metaObject) { this.strictUpdateFill(metaObject, "updateTime", Date.class, new Date()); } }
在做完上述配置后，当写入数据时，Mybatis-Plus会自动将实体对象的create_time字段填充为当前时间，当更新数据时，则会自动将实体对象的update_time字段填充为当前时间。
3、根据ID删除支付方式
查看接口，运行项目后，访问localhost:8080/doc.html
点击支付方式管理
再点击根据ID删除支付方式
//响应示例
{
"code": 0,
"message": "",
"data": {}
}
进行开发
在PaymentTypeController中增加如下方法
@Operation(summary = "根据ID删除支付方式")
@DeleteMapping("deleteById")
public Result deletePaymentById(@RequestParam Long id) {
service.removeById(id);
return Result.ok();
}
知识点：
MybatisPlus逻辑删除功能的使用。
