项目设计与 CodeReview

// Bad: 重复的日期格式化代码出现5次
const date1 = d.toLocaleDateString();
const date2 = d.toLocaleDateString();

// Good: 提取公共函数
const formatDate = (d) => d.toLocaleDateString();

// Bad: 过度设计
class DateFormatterFactory { ... }

// Good: 简单直接
const formatDate = (d) => d.toLocaleDateString();

// Bad: 提前设计了不需要的多语言支持
const i18n = { zh: {...}, en: {...}, ja: {...} };

// Good: 先只做中文,需要时再加
const labels = { title: '生产看板' };

// routes/oee.js - 只管路由
router.get('/oee', oeeController.getOEE);

// controllers/oee.js - 只管业务逻辑
exports.getOEE = (req, res) => { ... };

// models/production.js - 只管数据
exports.getByMachine = (id) => { ... };

// Bad: 一个函数做三件事
function processOrder() { /* 验证 + 计算 + 发邮件 */ }

// Good: 拆成三个函数
function validateOrder() { }
function calculateTotal() { }
function sendNotification() { }

// Bad: 每加一个报表类型就改switch
switch(type) { case 'oee': ...; case 'quality': ...; }

// Good: 注册机制,新报表只需注册
const reports = {};
const registerReport = (type, fn) => reports[type] = fn;

// Bad: 子类改变了父类行为
class Bird { fly() {} }
class Penguin extends Bird {
  fly() { throw new Error("can't fly"); }
}

// Good: 更合理的继承结构
class Bird { move() {} }
class FlyingBird extends Bird { fly() {} }

// Bad: 一个大接口包含所有方法
interface IWorker { work(); eat(); sleep(); }

// Good: 拆成小接口
interface IWorkable { work(); }
interface IFeedable { eat(); }

// Bad: 直接依赖具体实现
const db = new MySQLDatabase();

// Good: 依赖抽象,可替换
const db = createDatabase(config);
// 可以是 MySQL / PostgreSQL / SQLite

// Bad: 深层继承
class AdminUser extends User { }

// Good: 组合
const user = {
  auth: new RoleAuth('admin'),
  logger: new ActivityLogger()
};

// Bad: 知道太多内部结构
order.customer.address.city;

// Good: 通过方法获取
order.getShippingCity();

// Bad: 不校验,错误到后面才爆
function createOrder(data) { save(data); }

// Good: 入口就校验
function createOrder(data) {
  if (!data.items) throw new Error('items required');
  save(data);
}

// 修 bug 时顺便:
// - 重命名一个不清楚的变量
// - 加一条有用的注释
// - 删掉一行无用代码
// 每次一点点,代码库越来越好

// Bad: 还没上线就加缓存
const cache = new Map();

// Good: 上线后,用数据证明需要缓存
// "这个接口平均响应 3s,加了缓存降到 50ms"

// Bad: 每个路由都配置一遍
app.get('/api/v1/oee', ...);
app.get('/api/v1/production', ...);

// Good: 约定目录结构自动注册路由
// routes/oee.js → /api/v1/oee
// routes/production.js → /api/v1/production
autoRegisterRoutes(app);