如何写好业务代码

Posted 2023-04-24

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了如何写好业务代码相关的知识，希望对你有一定的参考价值。

参考技术A 烟囱式开发模式：

上述开发模式有几个弊端：

这样开发模式的优势：

业务代码集中在业务层 service,专注于业务对象 bo 的封装以及业务对象给展示层 vo的转换，封装复用逻辑，可以减少大量重复的代码，后期维护便捷的多。

数据库改动只设计dao层，快速响应各个业务。

业务代码如何拒绝 all in one

以上的controller代码最突出的缺点就是代码完全无法复用，完全没有使用到面向对象封装，集成，多态的特性。业务开发中，一般都是权限校验，参数校验，业务判断，业务对象转换数据库操作。

我的做法是业务抽象，把公共代码进行抽取，通过配置的形式的方式调用，使业务代码可以以可插拔的方式选择指定的权限校验，参数校验。简单来说，就是善用AOP面向切面编程的思想，示例如下：

使用aop对权限校验逻辑进行抽取，能够通过注解的方式指定哪些controller需要进行权限校验。对用户进行数据过滤时，使用controller的拦截器获取该用户拥有的各类权限，并把用户数据保存在上下文threadloal中，并且通过配置对指定url进行拦截。在业务层，从上下文拿到用户权限数据做各类数据业务过滤，通过aop实现各类拦截业务的指定调用。

使用java validtion对通用的字段，例如电话号码，身份证，进行扩展，详细可以参考，如何使用validation校验参数？，在项目中其他类似校验进行复用。

业务判断：使用设计模式对不同类型的业务开发进行封装，集成，多态扩展；这样在后期的扩展中可以基于开发封闭原则，针对新的业务扩展子类即可。

业务开发过程中，依照阿里巴巴研发规范的要求，存在DO(数据库表结构一致的对象)，BO（业务对象）,DTO(数据传输对象)，VO（显示层对象），Query（查询对象）。

使用MapStruct，可以灵活的控制的不同属性值之间的转换规格，比org.springframework.beans.BeanUtils.copyProperties()方法更加灵活。

例如，公共字段，生成日期，创建人，修改时间，修改人使用插件的形式进行封装，在mybatis-plus中使用MetaObjectHandler，在执行sql之前完成统一字段值的填充。

项目如何做好代码注释？

在业务中特别是状态的值，在对外发布api的vo对象中，加上状态枚举值的注释，并且使用@link 注解，可以直接连接到枚举类，让开发者一目了然。

举个例子，如何写好业务代码！

你知道的越多，不知道的就越多，业余的像一棵小草！

成功路上并不拥挤，因为坚持的人不多。

编辑：业余草

toutiao.com/i6903053083555807752/

说明

这里举一个非常简单的例子，以案例的业务实现来分析如何写好业务代码。

本案例只是简单的模拟，可能与真实的情况有出入，这里只是为了举例使用。

案例：

用户挑选商品放入购物车，然后下单结算，流程如下：

挑选商品 > 下单 > 结算 > 生成订单 > 通知

提交下单的业务逻辑如下：

验证账号是否合法 > 调用第三方接口查看商品的打折价格 > 钱包金额扣除 > 生成订单信息 > 通知用户下单成功，等待收货

代码实现

@Service
public class OrderServiceImpl implements OrderService {
    @Autowired
    private UserMapper userMapper;
    @Autowired
    private ProductMapper productMapper;
    @Autowired
    private OrderMapper orderMapper;
    @Autowired
    private KafkaTemplate kafkaTemplate;

    /**
     *  购买商品，提交订单
     * @param userId      用户ID
     * @param productId   商品ID
     * @return
     */
    public Result submit(Long userId, Long productId) throws BizException {
        // 验证账号
        UserDO userDO = userMapper.findById(userId);
        if (userDO == null) {
            throw BizException(USER_NOT_EXISTS);
        }
        // 查看商品信息及打折信息
        ProductDO productDO = productMapper.findById(productId);
        Double delta = HttpUtils.getDiscount(productId);
        double actualPayment = productDO.getPrice() - delta;
        Money money = userDO.getMoney();
        if (actualPayment > money.getRemain()) {
            // 如果商品价格 - 优惠价格 > 用户钱包，则说明不够付
            return Result.fail("余额不足");
        }
        // 钱包够付，扣除金额
        double remain = money.getRemain() - actualPayment;
        money.setRemain(remain);
        // 更新账号钱包余额
        userMapper.update(userDO);
        // 生成订单信息
        OrderDO orderDO = new OrderDO();
        orderDO.setUserId(userId);
        orderDO.setProductId(productId);
        orderMapper.save(orderDO);
        // 通知用户订单已生成，等待收货
        kafkaTemplate.send("orderTopic", orderDO);
        return Result.ok();
    }
}

上面代码写好了，而且可以实现相关功能，但是随着业务的迭代，可能会出现很多问题：

`可维护性差`

XxMapper是基于Mybatis实现数据操作层，也就把技术细节带入业务逻辑中了，如果技术实现变了（改为使用Hibernate，或Mybatis版本升级造成用法改变等），业务代码就得改变。
XxDO 是和数据表绑定的，数据表结构变更等也会影响业务代码。
调用第三方API，直接在业务代码中调用HttpUtils完成，未来第三方API修改了方法签名或返回值，或改为了RPC接口，那么业务代码也会随着改变。
发送消息直接使用KafkaTemplate，如果技术选型变了要改为使用RocketMQ，那么业务代码还得变。

`可扩展性差`

如果商品因为做活动又加了其他的优惠，或商品某一段时间不打折了，那么原有的代码就会重新改来改去；
业务逻辑和数据存储结构是强依赖的，数据存储结构的变化对业务的影响可想而知；

`可测试性差`

因为直接依赖了数据库，第三方接口，中间件，所以需要所有技术实现后才能进行测试，测试成本和时间都比较大。

代码优化一

我们上面说了，数据库操作不应该直接暴露在业务逻辑中，因此把数据库操作“隔离”开。

public interface UserRepository {
    User findById(Long userId);
}

新增 XxRepository 接口，业务逻辑直接依赖接口/抽象，而不应该直接依赖实现。

Repository 是数据仓库，不一定非得是 DB，也可以是其他的数据操作。

Repository 返回的对象也不是 DO，与数据库结构无关。

代码优化二

DO 对象是只有 set、get 操作，没有其他行为，我们说这有时是一种贫血现象，会导致本该在业务领域实体中完成的事情散落到各个 Service 中，低内聚而且也不好维护。

增加领域实体，相关行为直接在实体内完成（高内聚）：

public class Money {
    private double remain;
    public double getRemain() {
        return remain;
    }
    public void setRemain(double remain) {
        this.remain = remain;
    }
    /**
     * 扣费
     * @param delta
     * @return
     */
    public boolean charge(double delta) {
        if (remain < delta) {
            return false;
        }
        this.remain -= delta;
        return true;
    }
}

代码优化三

第三方接口是不可靠的，方法签名或返回值或调用方式都有可能会变的，如果直接在业务中依赖，会对业务造成“腐蚀”，所以应该加一层适配层（也叫防腐层 ACL）。

/**
 * 防腐层/适配层
 */
@Service
public class PayServiceImpl implements PayService {
 
    @Autowired
    private DiscountFacade discountFacade;

    /**
     *  支付
     * @param money
     * @param product
     * @return
     */
    public boolean pay(Money money, Product product) {
        // 获取优惠
        Double delta = discountFacade.getDiscount(product.getId());
        // 扣除费用
        return money.charge(product.getPrice() - delta);
    }
}

代码优化四

抽象中间件，不直接依赖具体的 MQ 实现

public interface MessageProducer<T, R> {
    Result<R> send(T message);
}

总结

优化后的代码如下：

@Autowired
private UserRepository userRepository;
@Autowired
private ProductRepository productRepository;
@Autowired
private OrderRepository orderRepository;
@Autowired
private MessageProducer<Order,Result> messageProducer;
@Autowired
private PayService payService;

/**
 * 购买商品，提交订单
 * @param userId      用户ID
 * @param productId   商品ID
 * @return
 */
public Result submit(Long userId, Long productId) throws BizException {
    // 验证
    User user = userRepository.findByUserId(userId);
    if (user == null) {
        throw BizException(USER_NOT_EXISTS);
    }
    // 支付
    Product product = productRepository.findById(productId);
    boolean f = payService.pay(user.getMoney(), product);
    if (!f) {
        return Result.fail("费用扣除失败");
    }
    // 更新账户
    userRepository.update(user);
    // 生成订单信息
    Order order = OrderFactory.create(user, product);
    orderRepository.add(order);
    // 通知用户订单已生成，等待收货
    messageProducer.send(order);
    return Result.ok();
}

代码不一定非常严谨，只是通过这一个简单的例子告诉大家实际工作中代码该怎么写，该遵循哪些目标：

独立于框架：架构不应该依赖某个外部的库或框架，不应该被框架的结构所束缚。
独立于 UI：前台展示的样式可能会随时发生变化（今天可能是网页、明天可能变成 console、后天是独立 app），但是底层架构不应该随之而变化。
独立于底层数据源：无论今天你用 MySQL、Oracle 还是 MongoDB、CouchDB，甚至使用文件系统，软件架构不应该因为不同的底层数据储存方式而产生巨大改变。
独立于外部依赖：无论外部依赖如何变更、升级，业务的核心逻辑不应该随之而大幅变化。
可测试：无论外部依赖了什么数据库、硬件、UI或者服务，业务的逻辑应该都能够快速被验证正确性。