
本文已收录在Github,关注我,紧跟本系列专栏文章,咱们下篇再续!
本文就教你如何优雅消除重复代码并改变你对业务代码没技术含量的观念。
很多 crud 工程师抱怨业务开发没有技术含量,什么设计模式、高并发都用不到,就是堆CRUD。每次面试被问到“讲讲常用设计模式?”,都只能把单例讲到精通,其他设计模式即使听过也只会简单说说,因为根本没实际用过。
对于反射、注解,也只是知道在框架中用的很多,但自己又不写框架,更不知道该如何使用。
提升项目的可维护性是每个 coder 必须注意的,非常重要的一个手段就是减少代码重复,因为重复过多会导致:
消除多if和重复代码!
开发购物车下单,对不同用户不同处理:
实现三种类型的购物车业务逻辑,把入参Map对象(K:商品ID,V:商品数量),转换为出参购物车类型Cart。
购物车
public class Cart {
/** 商品清单 */
private List<Item> items = new ArrayList<>();
/** 总折扣 */
private BigDecimal totalDiscount;
/** 商品总价 */
private BigDecimal totalItemPrice;
/** 总运费 */
private BigDecimal totalDeliveryPrice;
/** 应付总价 */
private BigDecimal payPrice;
}购物车中的商品
public class Item {
/** 商品Id */
private long id;
/** 商品数量 */
private int quantity;
/** 商品单价 */
private BigDecimal price;
/** 商品优惠 */
private BigDecimal couponPrice;
/** 商品运费 */
private BigDecimal deliveryPrice;
}public class NormalUserCart {
public Cart process(long userid, Map<Long, Integer> items) {
Cart cart = new Cart();
// 购物车Map 转为 Item list
List<Item> itemList = new ArrayList<>();
items.forEach((key, value) -> {
Item item = new Item();
item.setId(key);
item.setPrice(Db.getItemPrice(key));
item.setQuantity(value);
itemList.add(item);
});
cart.setItems(itemList);
itemList.forEach(item -> {
// 运费为商品总价的10%
item.setDeliveryPrice(item.getPrice().multiply(BigDecimal.valueOf(item.getQuantity()))
.multiply(new BigDecimal("0.1")));
// 无优惠
item.setCouponPrice(BigDecimal.ZERO);
});
// 计算纯商品总价
cart.setTotalItemPrice(cart.getItems().stream()
.map(item -> item.getPrice().multiply(BigDecimal.valueOf(item.getQuantity())))
.reduce(BigDecimal.ZERO, BigDecimal::add));
// 计算总运费
cart.setTotalDeliveryPrice(cart.getItems().stream().map(Item::getDeliveryPrice)
.reduce(BigDecimal.ZERO, BigDecimal::add));
// 计算总优惠
cart.setTotalDiscount(cart.getItems().stream().map(Item::getCouponPrice)
.reduce(BigDecimal.ZERO, BigDecimal::add));
// 应付总价=商品总价+运费总价-总优惠
cart.setPayPrice(cart.getTotalItemPrice().add(cart.getTotalDeliveryPrice()).subtract(cart.getTotalDiscount()));
return cart;
}
}VIP用户能享受同类商品多买的折扣。只需额外处理多买折扣部分。
public class VipUserCart {
public Cart process(long userId, Map<Long, Integer> items) {
Cart cart = new Cart();
List<Item> itemList = new ArrayList<>();
items.forEach((key, value) -> {...});
cart.setItems(itemList);
itemList.forEach(item -> {
//运费为商品总价的10%
item.setDeliveryPrice(item.getPrice().multiply(BigDecimal.valueOf(item.getQuantity()))
.multiply(new BigDecimal("0.1")));
//购买两件以上相同商品,第三件开始享受一定折扣
if (item.getQuantity() > 2) {
item.setCouponPrice(item.getPrice()
.multiply(BigDecimal.valueOf(100 - Db.getUserCouponPercent(userId)))
.divide(new BigDecimal("100"))
.multiply(BigDecimal.valueOf(item.getQuantity() - 2)));
} else {
item.setCouponPrice(BigDecimal.ZERO);
}
});
cart.setTotalItemPrice(cart.getItems().stream()
.map(item -> item.getPrice().multiply(BigDecimal.valueOf(item.getQuantity())))
.reduce(BigDecimal.ZERO, BigDecimal::add));
cart.setTotalDeliveryPrice(cart.getItems().stream().map(Item::getDeliveryPrice)
.reduce(BigDecimal.ZERO, BigDecimal::add));
cart.setTotalDiscount(cart.getItems().stream().map(Item::getCouponPrice)
.reduce(BigDecimal.ZERO, BigDecimal::add));
cart.setPayPrice(cart.getTotalItemPrice().add(cart.getTotalDeliveryPrice()).subtract(cart.getTotalDiscount()));
return cart;
}
}免运费、无折扣,只处理商品折扣和运费时的逻辑差异。
public class InternalUserCart {
public Cart process(long userId, Map<Long, Integer> items) {
Cart cart = new Cart();
List<Item> itemList = new ArrayList<>();
items.forEach((key, value) -> {
Item item = new Item();
item.setId(key);
item.setPrice(Db.getItemPrice(key));
item.setQuantity(value);
itemList.add(item);
});
cart.setItems(itemList);
itemList.forEach(item -> {
//免运费
item.setDeliveryPrice(BigDecimal.ZERO);
//无优惠
item.setCouponPrice(BigDecimal.ZERO);
});
cart.setTotalItemPrice(cart.getItems().stream().map(item -> item.getPrice()
.multiply(BigDecimal.valueOf(item.getQuantity()))).reduce(BigDecimal.ZERO, BigDecimal::add));
cart.setTotalDeliveryPrice(cart.getItems().stream().map(Item::getDeliveryPrice).reduce(BigDecimal.ZERO, BigDecimal::add));
cart.setTotalDiscount(cart.getItems().stream().map(Item::getCouponPrice).reduce(BigDecimal.ZERO, BigDecimal::add));
cart.setPayPrice(cart.getTotalItemPrice().add(cart.getTotalDeliveryPrice()).subtract(cart.getTotalDiscount()));
return cart;
}
}三种购物车超过一半代码重复。虽然不同类型用户计算运费和优惠的方式不同,但整个购物车的初始化、统计总价、总运费、总优惠和支付价格逻辑都一样。
代码重复本身不可怕,可怕的是漏改或改错。如写VIP用户购物车的同学发现商品总价计算有Bug,不应该是把所有Item的price加在一起,而是应该把所有Item的price*quantity相加。
他可能只修VIP用户购物车的代码,漏了普通用户、内部用户的购物车中重复逻辑实现的相同Bug。
有三个购物车,就需根据不同用户类型使用不同购物车。
使用多if实现不同类型用户调用不同购物车process
@GetMapping("wrong")
public Cart wrong(@RequestParam("userId") int userId) {
String userCategory = Db.getUserCategory(userId);
if ("Normal".equals(userCategory)) {
NormalUserCart normalUserCart = new NormalUserCart();
return normalUserCart.process(userId, items);
}
if ("Vip".equals(userCategory)) {
VipUserCart vipUserCart = new VipUserCart();
return vipUserCart.process(userId, items);
}
if ("Internal".equals(userCategory)) {
InternalUserCart internalUserCart = new InternalUserCart();
return internalUserCart.process(userId, items);
}
return null;
}就只能不断增加更多的购物车类,写重复的购物车逻辑、写更多if逻辑吗?
当然不是,相同的代码应该只在一处出现!
可以把重复逻辑定义在抽象类,三个购物车只要分别实现不同部分的逻辑。
这其实就是模板方法模式。
在父类中实现购物车处理的流程模板,然后把需要特殊处理的留抽象方法定义,让子类去实现。由于父类逻辑无法单独工作,因此需要定义为抽象类。
如下代码所示,AbstractCart抽象类实现了购物车通用的逻辑,额外定义了两个抽象方法让子类去实现。其中,processCouponPrice方法用于计算商品折扣,processDeliveryPrice方法用于计算运费。
public abstract class AbstractCart {
public Cart process(long userId, Map<Long, Integer> items) {
Cart cart = new Cart();
List<Item> itemList = new ArrayList<>();
items.forEach((key, value) -> {
Item item = new Item();
item.setId(key);
item.setPrice(Db.getItemPrice(key));
item.setQuantity(value);
itemList.add(item);
});
cart.setItems(itemList);
itemList.forEach(item -> {
processCouponPrice(userId, item);
processDeliveryPrice(userId, item);
});
cart.setTotalItemPrice(cart.getItems().stream().map(item -> item.getPrice()
.multiply(BigDecimal.valueOf(item.getQuantity()))).reduce(BigDecimal.ZERO, BigDecimal::add));
cart.setTotalDeliveryPrice(cart.getItems().stream().map(Item::getDeliveryPrice).reduce(BigDecimal.ZERO, BigDecimal::add));
cart.setTotalDiscount(cart.getItems().stream().map(Item::getCouponPrice).reduce(BigDecimal.ZERO, BigDecimal::add));
cart.setPayPrice(cart.getTotalItemPrice().add(cart.getTotalDeliveryPrice()).subtract(cart.getTotalDiscount()));
return cart;
}
protected abstract void processCouponPrice(long userId, Item item);
protected abstract void processDeliveryPrice(long userId, Item item);
}有抽象类,三个子类的实现就简单了。
普通用户的购物车NormalUserCart,实现0优惠和10%运费
@Service(value = "NormalUserCart")
public class NormalUserCart extends AbstractCart {
@Override
protected void processCouponPrice(long userId, Item item) {
item.setCouponPrice(BigDecimal.ZERO);
}
@Override
protected void processDeliveryPrice(long userId, Item item) {
item.setDeliveryPrice(item.getPrice()
.multiply(BigDecimal.valueOf(item.getQuantity()))
.multiply(new BigDecimal("0.1")));
}
}VIP用户的购物车VipUserCart,直接继承NormalUserCart,只需修改多买优惠策略
@Service(value = "VipUserCart")
public class VipUserCart extends NormalUserCart {
@Override
protected void processCouponPrice(long userId, Item item) {
if (item.getQuantity() > 2) {
item.setCouponPrice(item.getPrice()
.multiply(BigDecimal.valueOf(100 - Db.getUserCouponPercent(userId)))
.divide(new BigDecimal("100"))
.multiply(BigDecimal.valueOf(item.getQuantity() - 2)));
} else {
item.setCouponPrice(BigDecimal.ZERO);
}
}
}内部用户购物车InternalUserCart最简单,直接设置0运费、0折扣
@Service(value = "InternalUserCart")
public class InternalUserCart extends AbstractCart {
@Override
protected void processCouponPrice(long userId, Item item) {
item.setCouponPrice(BigDecimal.ZERO);
}
@Override
protected void processDeliveryPrice(long userId, Item item) {
item.setDeliveryPrice(BigDecimal.ZERO);
}
}
既然三个购物车都叫XXXUserCart,可将用户类型字符串拼接UserCart构成购物车Bean的名称,然后利用IoC容器,通过Bean的名称直接获取到AbstractCart,调用其process方法即可实现通用。
这就是工厂模式,借助Spring容器实现:
@GetMapping("clean")
public Cart right(@RequestParam("userId") int userId) {
String userCategory = Db.getUserCategory(userId);
AbstractCart cart = (AbstractCart) applicationContext.getBean(userCategory + "UserCart");
return cart.process(userId, items);
}若有新用户类型、用户逻辑,只要新增一个XXXUserCart类继承AbstractCart,实现特殊的优惠和运费处理逻辑即可。
工厂+模板方法模式,消除了重复代码,还避免修改既有代码。这就是设计模式中的OCP:对修改关闭,对扩展开放。
银行提供了一些API接口,对参数的序列化不使用JSON,而需要我们把参数依次拼在一起构成一个大字符串。
比如,创建用户方法和支付方法的定义是这样的:
以下是识别后的表格(整理为清晰格式):
接口信息 | 详情 |
|---|---|
创建用户接口 | http://baseURL/reflection/bank/createUser |
参数名 | 参数顺序 | 参数类型 | 参数长度 |
|---|---|---|---|
姓名 | 1 | 字符串(S) | 10 |
身份证 | 2 | 字符串(S) | 18 |
年龄 | 3 | 数字(N) | 5 |
手机号 | 4 | 字符串(S) | 11 |
接口信息 | 详情 |
|---|---|
支付接口 | http://baseURL/reflection/bank/pay |
参数名 | 参数顺序 | 参数类型 | 参数长度 |
|---|---|---|---|
用户ID | 1 | 数字(N) | 20 |
支付金额 | 2 | 货币(M) | 10 |
直接根据接口定义实现填充、加签名、请求调用:
public class BankService {
// 创建用户
public static String createUser(String name, String identity, String mobile, int age) throws IOException {
StringBuilder stringBuilder = new StringBuilder();
// 字符串靠左,多余的地方填充_
stringBuilder.append(String.format("%-10s", name).replace(' ', '_'));
stringBuilder.append(String.format("%-18s", identity).replace(' ', '_'));
// 数字靠右,多余的地方用0填充
stringBuilder.append(String.format("%05d", age));
// 字符串靠左
stringBuilder.append(String.format("%-11s", mobile).replace(' ', '_'));
// MD5签名
stringBuilder.append(DigestUtils.md2Hex(stringBuilder.toString()));
return Request.Post("http://localhost:45678/reflection/bank/createUser")
.bodyString(stringBuilder.toString(), ContentType.APPLICATION_JSON)
.execute().returnContent().asString();
}
// 支付
public static String pay(long userId, BigDecimal amount) {
StringBuilder sb = new StringBuilder();
// 数字靠右
sb.append(String.format("%020d", userId));
// 金额向下舍入2位到分,以分为单位,作为数字靠右,多余的地方用0填充
sb.append(String.format("%010d", amount.setScale(2, RoundingMode.DOWN).multiply(new BigDecimal("100")).longValue()));
// MD5签名
sb.append(DigestUtils.md2Hex(stringBuilder.toString()));
return Request.Post("http://localhost:45678/reflection/bank/pay")
.bodyString(sb.toString(), ContentType.APPLICATION_JSON)
.execute().returnContent().asString();
}
}这段代码的重复粒度更细:
针对银行请求的所有逻辑均使用一套代码实现,不会出现任何重复。
要实现接口逻辑和逻辑实现的剥离,首先要以POJO类定义所有的接口参数。
@Data
public class CreateUserAPI {
private String name;
private String identity;
private String mobile;
private int age;
}有了接口参数定义,就能自定义注解,为接口和所有参数增加一些元数据。如定义一个接口API的注解BankAPI,包含接口URL地址和接口说明
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Inherited
public @interface BankAPI {
String desc() default "";
String url() default "";
}再自定义注解@BankAPIField,描述接口的每一个字段规范,包含参数的次序、类型和长度三个属性:
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@Documented
@Inherited
public @interface BankAPIField {
/**
* 参数的次序
* @return
*/
int order() default -1;
/**
* 长度
* @return
*/
int length() default -1;
/**
* 类型
* @return
*/
String type() default "";
}定义CreateUserAPI描述创建用户接口的信息,为接口增加@BankAPI,来补充接口的URL和描述等元数据;为每个字段增加@BankAPIField,来补充参数的顺序、类型和长度等元数据:
@BankAPI(url = "/bank/createUser", desc = "创建用户接口")
@Data
public class CreateUserAPI extends AbstractAPI {
@BankAPIField(order = 1, type = "S", length = 10)
private String name;
@BankAPIField(order = 2, type = "S", length = 18)
private String identity;
@BankAPIField(order = 4, type = "S", length = 11)
private String mobile;
@BankAPIField(order = 3, type = "N", length = 5)
private int age;
}类似的PayAPI类:
@BankAPI(url = "/bank/pay", desc = "支付接口")
@Data
public class PayAPI extends AbstractAPI {
@BankAPIField(order = 1, type = "N", length = 20)
private long userId;
@BankAPIField(order = 2, type = "M", length = 10)
private BigDecimal amount;
}他俩继承的AbstractAPI类是空实现,因为该例接口无公共数据。
public abstract class AbstractAPI {
}通过这俩类,即可快速核对API清单表格。若核心翻译过程(把注解和接口API序列化为请求需要的字符串)没问题,只要注解和表格一致,API请求翻译就没问题。这就通过注解实现了对API参数的描述。
下面看反射咋配合注解实现动态的接口参数组装:
private static String remoteCall(AbstractAPI api) throws IOException {
// 从类上获得 @BankAPI,获其URL属性以远程调用
BankAPI bankAPI = api.getClass().getAnnotation(BankAPI.class);
bankAPI.url();
StringBuilder stringBuilder = new StringBuilder();
Arrays.stream(api.getClass().getDeclaredFields()) //获得所有字段
// 过滤带 @BankAPIField 的字段
.filter(field -> field.isAnnotationPresent(BankAPIField.class))
// 根据注解的order属性,对字段排序
.sorted(Comparator.comparingInt(a -> a.getAnnotation(BankAPIField.class).order()))
// 设置可访问私有字段
.peek(field -> field.setAccessible(true))
.forEach(field -> {
// 实现了反射获取注解的值,根据BankAPIField拿到的参数类型,按照三种标准进行格式化,将所有参数的格式化逻辑集中在这处
// 获得注解
BankAPIField bankAPIField = field.getAnnotation(BankAPIField.class);
Object value = "";
try {
// 反射获取字段值
value = field.get(api);
} catch (IllegalAccessException e) {
e.printStackTrace();
}
// 根据字段类型以正确的填充方式格式化字符串
switch (bankAPIField.type()) {
case "S": {
stringBuilder.append(String.format("%-" + bankAPIField.length() + "s", value.toString()).replace(' ', '_'));
break;
}
case "N": {
stringBuilder.append(String.format("%" + bankAPIField.length() + "s", value.toString()).replace(' ', '0'));
break;
}
case "M": {
if (!(value instanceof BigDecimal))
throw new RuntimeException(String.format("{} 的 {} 必须是BigDecimal", api, field));
stringBuilder.append(String.format("%0" + bankAPIField.length() + "d", ((BigDecimal) value).setScale(2, RoundingMode.DOWN).multiply(new BigDecimal("100")).longValue()));
break;
}
default:
break;
}
});
// 实现参数加签和请求调用
// 签名逻辑stringBuilder.append(DigestUtils.md2Hex(stringBuilder.toString()));
String param = stringBuilder.toString();
long begin = System.currentTimeMillis();
// 请求
String result = Request.Post("http://localhost:45678/reflection" + bankAPI.url())
.bodyString(param, ContentType.APPLICATION_JSON)
.execute().returnContent().asString();
return result;
}所有处理参数排序、填充、加签、请求调用的核心逻辑,都汇聚在remoteCall。有这方法,BankService每个接口实现就简单了:参数组装,再调用remoteCall。
public static String createUser(String name, String identity, String mobile, int age) throws IOException {
CreateUserAPI createUserAPI = new CreateUserAPI();
createUserAPI.setName(name);
createUserAPI.setIdentity(identity);
createUserAPI.setAge(age);
createUserAPI.setMobile(mobile);
return remoteCall(createUserAPI);
}
public static String pay(long userId, BigDecimal amount) throws IOException {
PayAPI payAPI = new PayAPI();
payAPI.setUserId(userId);
payAPI.setAmount(amount);
return remoteCall(payAPI);
}涉及类结构性的通用处理,都可按照该模式减少重复代码:
对于三层架构系统,层间解耦及每层对数据的不同需求,每层都会有自己的POJO实体。
手动写这些实体之间的赋值代码,容易出错。对于复杂业务系统,实体有几十甚至几百个属性也很正常。比如ComplicatedOrderDTO,描述一个订单中几十个属性。如果转换为一个类似的DO,复制其中大部分的字段,然后把数据入库,势必需要进行很多属性映射赋值操作。就像这样,密密麻麻的代码是不是已经让你头晕了?
ComplicatedOrderDTO orderDTO = new ComplicatedOrderDTO();
ComplicatedOrderDO orderDO = new ComplicatedOrderDO();
orderDO.setAcceptDate(orderDTO.getAcceptDate());
orderDO.setAddress(orderDTO.getAddress());
orderDO.setAddressId(orderDTO.getAddressId());
orderDO.setCancelable(orderDTO.isCancelable());
orderDO.setCommentable(orderDTO.isComplainable()); //属性错误
orderDO.setComplainable(orderDTO.isCommentable()); //属性错误
orderDO.setCancelable(orderDTO.isCancelable());
orderDO.setCouponAmount(orderDTO.getCouponAmount());
orderDO.setCouponId(orderDTO.getCouponId());
orderDO.setCreateDate(orderDTO.getCreateDate());
orderDO.setDirectCancelable(orderDTO.isDirectCancelable());
orderDO.setDeliverDate(orderDTO.getDeliverDate());
orderDO.setDeliverGroup(orderDTO.getDeliverGroup());
orderDO.setDeliverGroupOrderStatus(orderDTO.getDeliverGroupOrderStatus());
orderDO.setDeliverMethod(orderDTO.getDeliverMethod());
orderDO.setDeliverPrice(orderDTO.getDeliverPrice());
orderDO.setDeliveryManId(orderDTO.getDeliveryManId());
orderDO.setDeliveryManMobile(orderDO.getDeliveryManMobile()); //对象错误
orderDO.setDeliveryManName(orderDTO.getDeliveryManName());
orderDO.setDistance(orderDTO.getDistance());
orderDO.setExpectDate(orderDTO.getExpectDate());
orderDO.setFirstDeal(orderDTO.isFirstDeal());
orderDO.setHasPaid(orderDTO.isHasPaid());
orderDO.setHeadPic(orderDTO.getHeadPic());
orderDO.setLongitude(orderDTO.getLongitude());
orderDO.setLatitude(orderDTO.getLongitude()); //属性赋值错误
orderDO.setMerchantAddress(orderDTO.getMerchantAddress());
orderDO.setMerchantHeadPic(orderDTO.getMerchantHeadPic());
orderDO.setMerchantId(orderDTO.getMerchantId());
orderDO.setMerchantAddress(orderDTO.getMerchantAddress());
orderDO.setMerchantName(orderDTO.getMerchantName());
orderDO.setMerchantPhone(orderDTO.getMerchantPhone());
orderDO.setOrderNo(orderDTO.getOrderNo());
orderDO.setOutDate(orderDTO.getOutDate());
orderDO.setPayable(orderDTO.isPayable());
orderDO.setPaymentAmount(orderDTO.getPaymentAmount());
orderDO.setPaymentDate(orderDTO.getPaymentDate());
orderDO.setPaymentMethod(orderDTO.getPaymentMethod());
orderDO.setPaymentTimeLimit(orderDTO.getPaymentTimeLimit());
orderDO.setPhone(orderDTO.getPhone());
orderDO.setRefundable(orderDTO.isRefundable());
orderDO.setRemark(orderDTO.getRemark());
orderDO.setStatus(orderDTO.getStatus());
orderDO.setTotalQuantity(orderDTO.getTotalQuantity());
orderDO.setUpdateTime(orderDTO.getUpdateTime());
orderDO.setName(orderDTO.getName());
orderDO.setUid(orderDTO.getUid());如果原始的DTO有100个字段,我们需要复制90个字段到DO中,保留10个不赋值,最后应该如何校验正确性呢?
使用类似BeanUtils这种Mapping工具来做Bean的转换,copyProperties方法还允许我们提供需要忽略的属性:
ComplicatedOrderDTO orderDTO = new ComplicatedOrderDTO();
ComplicatedOrderDO orderDO = new ComplicatedOrderDO();
BeanUtils.copyProperties(orderDTO, orderDO, ...ignoreProperties: "id");
return orderDO;重复代码多了总有一天会出错。
代码重复度是评估一个项目质量的重要指标,如果一个项目几乎没有任何重复代码,那么它内部抽象一定非常好。重构时,首要任务是消除重复。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。