如何构建一套基于 ESLint 插件的领域驱动设计(DDD)代码规范检测

夜宇小哥_4171

夜宇小哥_4171

2026-04-20

838人浏览

原创

不能。eslint仅分析ast,不理解ddd语义,需将aggregate、domainevent等约束转化为基于路径、命名、导入关系和类结构的可检测代码模式。

如何构建一套基于 eslint 插件的领域驱动设计(ddd)代码规范检测

ESLint 能否直接检测 DDD 概念?

不能。ESLint 本身只分析 AST,不理解 Aggregate、DomainEvent、Repository 这类业务语义。它只能识别语法结构(如类声明、函数调用、导入路径),无法判断一个类是否“应该”是值对象还是实体——这需要你把 DDD 约束翻译成可检测的代码模式。

如何把 DDD 规则转成 ESLint 可执行的规则

核心思路是:用文件路径 + 命名约定 + 导入关系 + 类声明结构,组合出可验证的契约。例如:

  • src/domain/user/ 下的 *.ts 文件,若导出类名以 Aggregate 结尾,必须继承自 BaseAggregate(通过 ClassDeclaration.superClass AST 节点校验)
  • src/domain/**/events/ 下的文件,导出的类必须实现 DomainEvent 接口(检查 implements 子句或类型断言)
  • src/infrastructure/persistence/ 中的文件,禁止直接 import src/application/ 或 src/domain/(用 ImportDeclaration + source.value 正则匹配拦截)
  • src/domain/**/value-objects/ 中的类,必须是 export class 且不含 private 构造函数以外的任何方法(遍历 ClassBody.body,过滤掉 Constructor 和 MethodDefinition)

实际落地要绕开哪些坑

很多团队卡在第一步:写了个规则但没生效。常见原因包括:

WorkRally
WorkRally

WorkRally是一款由腾讯视频推出的AI漫剧智能创作平台。

下载
  • 插件未在 .eslintrc.js 的 plugins 数组里注册,或未在 rules 中显式启用(如 "my-ddd/no-domain-import-in-infrastructure": "error")
  • 规则依赖路径解析,但项目用了 tsconfig.json 的 paths 别名,ESLint 默认不处理——得配 eslint-import-resolver-typescript 并在 settings 里指定 project
  • 自定义规则里用 context.getSourceCode().getText() 做字符串匹配,结果被 TypeScript 编译前的装饰器、泛型等干扰;应优先用 AST 节点类型和属性判断(如 node.type === 'ClassDeclaration')
  • VSCode ESLint 插件默认只校验打开的文件,而 DDD 层间越界常发生在未打开的 infrastructure 文件里——需确保 eslint.workingDirectories 包含整个 src/,且 eslint.run 设为 "onSave" 或 "onType"

为什么建议从 “层间依赖” 和 “命名空间约束” 入手

DDD 最容易违反、也最易自动化的就是这两类。比起强行校验“这个类是否符合聚合根生命周期”,不如先守住底线:

  • 禁止 domain → infrastructure 的反向 import(用 no-restricted-imports 配置路径白名单)
  • 强制 application/use-cases 只能 import domain 和 shared(同上)
  • 所有 src/domain/**/entities/ 下的类名必须含 Entity 后缀(用 no-invalid-filename 自定义规则)

这些规则上线后,开发者立刻能感知到约束,后续再逐步叠加更细粒度的领域语义校验。别一上来就写 validate-aggregate-invariants——AST 里根本找不到“不变量”的节点。

相关文章

驱动精灵
驱动精灵

驱动精灵基于驱动之家十余年的专业数据积累,驱动支持度高,已经为数亿用户解决了各种电脑驱动问题、系统故障,是目前有效的驱动软件,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

代码规范

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

5046

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1249

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4964

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

960

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1896

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3545

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4613

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3020

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

968

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel 团队合作的 15 个技巧
Laravel 团队合作的 15 个技巧

共1课时 | 178人学习

PHP开发编码规范
PHP开发编码规范

共37课时 | 71.7万人学习

手把手带您写PHP框架_设计开发篇
手把手带您写PHP框架_设计开发篇

共18课时 | 4.1万人学习