Skip to main content

现有装饰器索引

场景作用
@midwayjs/decorator 提供
@Provide基础依赖注入暴露一个 class,让 IoC 容器能够获取元数据
@Inject注入一个 IoC 容器中的对象
@Scope实例管理指定作用域
@Init标注对象初始化时自动执行的方法
@Destroy标注对象销毁时执行的方法
@Async【已废弃】表明为异步函数
@Autowire【已废弃】标识类为自动注入属性
@Autoload让类可以自加载执行
@Configuration通用功能扩展标识一个容器入口配置类
@Aspect标识拦截器
@Validate标识方法,需要被验证
@Rule标识 DTO 的校验规则
@App注入当前应用实例
@Config获取配置
@Logger获取日志实例
@ControllerWeb 场景标识为一个 Web 控制器
@Get注册为一个 GET 类型的路由
@Post注册为一个 POST 类型的路由
@Del注册为一个 DELETE 类型的路由
@Put注册为一个 PUT 类型的路由
@Patch注册为一个 PATCH 类型的路由
@Options注册为一个 OPTIONS 类型的路由
@Head注册为一个 HEAD 类型的路由
@All注册为一个全类型的路由
@Session从参数获取 ctx.session
@Body从参数获取 ctx.body
@Query从参数获取 ctx.query
@Param从参数获取 ctx.param
@Headers从参数获取 ctx.headers
@Priority【废弃】路由加载优先级
@Redirect修改响应跳转
@HttpCode修改响应状态码
@SetHeader修改响应头
@ContentType修改响应头中的 Content-Type 字段
@ScheduleEgg标识为一个定时任务
@Plugin获取 egg 插件
@Provider微服务场景暴露微服务提供者(生产者)
@Consumer暴露微服务调用者(消费者)
@GrpcMethod标识暴露的 gRPC 方法
@Func函数场景【逐步废弃】标识为一个函数入口
@Handler【逐步废弃】配合标记函数
@Match【已废弃】
@ServerlessTrigger标识一个函数触发器
@Task任务模块定义一个分布式任务
@TaskLocal定义一个本地任务
@Queue定义一个自触发的任务
@midwayjs/orm 提供
@EntityModel定义一个实体对象
@InjectEntityModel注入一个实体对象
@EventSubscriberModel定义事件订阅
@midwayjs/swagger 提供
@CreateApiDoc创建一个 API
@CreateApiPropertyDoc创建一个 API 属性