Java常用注解整理

一. SpringMVC

  1. @Controller
    实际上是@Component,作为组件注册到ioc容器
  2. ResponseBody
    返回值将和response的body绑定,即页面会直接显示返回的内容
  3. @RestController
    相当于@Controller+@ResponseBody的组合注解
  4. @RequestBody
    用于获取请求body里的内容
  5. @RequestMapping
    用于定于访问路径。默认请求方式是GET
/**
 * value: uri地址
 * method: 指定请求的method类型, GET、POST、PUT、DELETE等
 * consumes: 指定Content-Type
 * produces: 指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;
 * params: 指定request中必须包含某些参数值是,才让该方法处理。
 * headers: 指定request中必须包含某些指定的header值,才能让该方法处理请求。
**/
@RequestMapping(value="/test", method = RequestMethod.GET)
  1. @RequestParam
    从请求URL中读取请求参数。默认是必须参数
/**
 * value: 入参的请求参数名字
 * required: 是否必须,默认是true
 * defaultValue: 默认值
**/
public String queryUserName((@RequestParam(value = "name", required = false, defaultValue = "honey") String name))
  1. @PathVariable
    获取URI中Path变量定义为花括号{}的内容
@RequestMapping(value = "/products/{id}", method = RequestMethod.PUT)
@PathVariable("id") String id
  1. @GetMapping("/{id}"),@PostMapping("/{id}"),@PutMapping("/{id}"),@DeleteMapping("/{id}")
    相当于指定了method参数的@RequestMapping

二. Mybatis

  1. @Mapper
    说明该接口的实现类由mybatis创建,并将生成后的对象注册到ioc容器中
  2. @MapperScan
    自动扫描某个包下的所有接口,相当于包下的所有接口都加上了@Mapper注解
  3. @Param
    对应sql中#{}占位符中的变量名称,常在不同类型时指定
    TDeposit queryByGuinoAndBoxid(@Param("guino")String guino, @Param("boxid")Integer boxid);
    
  4. @Alias
    在pojo类中使用,为其起一个别名,配合@Resource使用
    @Service,@Controller等注解集成了@Alias注解,直接通过value属性设置即可
    @Alias("author")
    public class Author {
      ...
    }
    @Service(value = "heheh")
    
  5. @Insert @Delete @Select @Update
    对应增删查改语句

三、Spring

  1. @Autowrie
    @Autowrie(require=false)
    自动装配bean,默认不允许值为null(即require=true),可以在属性上或者Set方法上使用
    先通过bytype的方式查找,再通过byname的方式查找
  2. @Resource (这个注解是javax的)
    自动装配bean
    先通过byname的方式查找,再通过bytype的方式查找
  3. @Qualifier(value="xxx")
    指定唯一的Bean注入(通过别名寻找),配合@Autowire使用
  4. @Nullable
    字段可以为null
  5. @Component、@Repository、@Service、@Controller
    注册Bean并装配到Spring容器中,通过类路径扫描来自动侦测,等价于<bean id="xx" class="xxx"/>
    一般@Component在pojo中使用、@Repository在Dao中使用、@Service在Service中使用、@Controller在Controller中使用
    本质上都是@Component
  6. @Value("xxx)
    注入值、等价于<property name="xxx" value="xxx"/>
  7. @Scope(value = "xxx")
    配置bean的作用域,默认是单例的,可放在属性上或set方法上
  8. @Configuration
    使一个Java类成为配置类,等价于<beans> ...... </beans>
  9. @ComponentScan("包名")
    根据指定的配置自动扫描package
    默认扫描规则是扫描被@Component, @Repository, @Service, @Controller或者已经声明过@Component自定义注解标记的组件
  10. @Import(配置类的class)
    将对应类注册到ioc容器中
    一般用于将包扫描路径外的类注册到ios容器中
  11. @Bean
    注册Bean并装配到Spring容器中,通常是在标有该注解的方法中定义产生这个bean的逻辑(即return对象)。,等价于<Bean id="方法名" class="返回值"/>
  12. @Aspect
    标注这个类是一个切面
    @Before("execution(* com.xxx.(..))")
    @After("execution(
    com.xxx.*(..))")

四. Lombok

  1. @Data
    包含@ToString、@EqualsAndHashCode、@Getter、@Setter的功能
  2. @ToString
    自动生成toSring()方法
  3. @Getter、@Setter
    自动生成get、set方法
  4. @NONNULL
    自动加上if (members == null) throw new java.lang.NullPointerException("members");
  5. @Synchronized
    自动给方法加同步锁
    synchronized ($lock) { ... }
  6. @Slf4j
    简化日志的定义

五. 异常处理

  1. @ControllerAdvice
    全局处理异常
  2. @ExceptionHandler
    @ExceptionHandler(value = ProductNotfoundException.class)
@ControllerAdvice
public class ProductExceptionController {
   @ExceptionHandler(value = ProductNotfoundException.class)
   public ResponseEntity<Object> exception(ProductNotfoundException exception) {
      return new ResponseEntity<>("Product not found", HttpStatus.NOT_FOUND);
   }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,240评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,328评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,182评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,121评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,135评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,093评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,013评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,854评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,295评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,513评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,678评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,398评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,989评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,636评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,801评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,657评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,558评论 2 352

推荐阅读更多精彩内容