注解规范

SW-X中使用注解注入需要极强的规范要求,否则注解会解析失败,具体要求如下:

  • 1、注解必须在/** */注释体内所包含
  • 2、一行注释为一条注解
  • 3、只对框架内置的注解元有效
  • 4、每条注解中的属性参数,都必须使用双引号做标记,例如:@Ioc(class="依赖的类", name="注入的成员属性名称")
  • 5、基本所有注解都是属性名称="",的方式传递参数,都是强制""双引号,后面接入一个,英文逗号

SW-X中支持的所有注解元如下,也可以参考这个作为注解的使用规范:


/**
 * @TestCase(class="\other\testcase\index\test1", title="用例一")
 * @Ioc(class="\x\Db", function="name('user')", name="Db")
 * @AopBefore(class="app\aop\Demo", function="before")
 * @AopAfter(class="app\aop\Demo", function="after")
 * @AopAround(class="app\aop\Demo", function="around")
 * @AopThrows(class="app\aop\Demo", function="throws")
 * @Param(name="id", type="int|string", value="1", empty="true", min="10", max="20", chinese="true", callback="\lifecycle\annotate_param")
 * @RequestMapping(route="/index", method="GET|POST", title="路由描述")
 * @Controller(prefix="user")
 * @onRoute
*/

每个注解元的解释如下:

  • TestCase:单元测试绑定
  • Ioc:属性注入
  • AopBefore:AOP前置操作
  • AopAfter:AOP后置操作
  • AopAround:AOP环绕操作
  • AopThrows:AOP异常转发
  • RequestMapping:方法对应的路由绑定
  • Controller:控制器的前置路由绑定
  • onRoute:申明某个方法不能被路由访问
  • Param:对GET或POST参数进行前置校验