写代码要遵循项目已有模式和最佳实践

确保代码遵循项目中已有的模式和最佳实践是确保软件质量的关键。下面我将通过一个例子来展示如何识别不符合项目最佳实践的代码，并对其进行改进。

旧代码示例

假设我们有一个在线商店的后端服务，其中包含一个用于处理商品库存的类。以下是旧的代码示例：

class Inventory:
    def __init__(self):
        self.stock = {}

    def add_product(self, product_id, quantity):
        if product_id in self.stock:
            self.stock[product_id] += quantity
        else:
            self.stock[product_id] = quantity

    def remove_product(self, product_id, quantity):
        if product_id in self.stock:
            if self.stock[product_id] >= quantity:
                self.stock[product_id] -= quantity
            else:
                print("Not enough stock!")
        else:
            print("Product not found!")

代码问题

• 使用了print语句来处理错误情况，这不是一种好的做法，特别是在生产环境中，因为它不利于错误追踪和日志管理。

• 方法add_product和remove_product的错误处理不一致，导致维护困难。

项目最佳实践

假设项目的最佳实践包括：

• 使用异常处理来管理错误。

• 使用日志库记录错误和重要信息，而不是使用print。

• 在类中使用更具表达性的方法名。

改进后的代码

import logging

# 配置日志
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')

class Inventory:
    def __init__(self):
        self.stock = {}
    
    def increment_stock(self, product_id, quantity):
        if product_id in self.stock:
            self.stock[product_id] += quantity
        else:
            self.stock[product_id] = quantity
        logging.info(f"Stock added: {quantity} units of {product_id}. Total stock: {self.stock[product_id]}.")

    def decrement_stock(self, product_id, quantity):
        try:
            if self.stock[product_id] >= quantity:
                self.stock[product_id] -= quantity
                logging.info(f"Stock removed: {quantity} units of {product_id}. Remaining stock: {self.stock[product_id]}.")
            else:
                raise ValueError("Insufficient stock available.")
        except KeyError:
            logging.error(f"Attempt to remove non-existent product {product_id} from stock.")
            raise KeyError("Product not found in inventory.")
        except ValueError as e:
            logging.error(str(e))
            raise
        

代码改进说明

• 日志记录：使用logging库代替print，这让错误信息和重要操作可以被适当地记录下来，便于监控和故障排查。

• 异常处理：通过抛出异常来处理错误情况，而不是简单地打印错误消息。

• 方法重命名：将add_product和remove_product重命名为increment_stock和decrement_stock，使得方法名更具表达性，更好地反映了它们的行为。

这个例子展示了如何根据项目的最佳实践对代码进行改进，以提高代码的可维护性、一致性和可扩展性。