SpringBoot常用注解

一、配置相关

@springBootApplication
通常在主类上,包含:

  • @Configuration:表明是配置文件
  • @EnableAutoConfiguration:根据依赖自动配置springBoot
  • @ComponentScan:告诉Spring从哪里找bean(注解的包及下级包)

@Profiles
隔离应用程序配置,让配置在特定环境生效。
标注于@Component 或者 @Configuration

二、注入Bean

@Repository
标记数据库访问组件DAO。

@Service
标记业务层组件。

@RestController
标记控制层组件,包含:

  • @Controller:标记控制层组件
  • @ResponseBody:根据前端dataType将返回的对象转换成相应格式jsonxml

@Component
泛指组件,不好归类时标记

@Bean
在方法上使用,产生一个bean,交给spring

三、使用Bean

@AutoWired
自动注入,可以作用于成员变量、方法、构造方法。(required=false)找不到bean也不报错

@Qualifier
当AutoWired有多个同类型bean时("name")指定

@Resource(name="name",type="type"):
没有括号内内容的话,默认byName。与@Autowired干类似的事。

四、网络请求相关

@RequestMapping
处理请求的地址映射,可在类与方法上。类上代表是方法上的父路径。
六个属性:

  • params:指定request中必须有某参数
  • headers:request中必须有指定的header
  • value:指定请求实际地址
  • method:指定类型,GET、POST....
  • consumes:指定处理提交类型(Content-Type),application/json,test/html等

@RequestParam
方法的参数前,获取指定名称的参数并传入形参(键值对类型的参数)

public User getUser(@RequestParam(value = "id", required = false) Integer id)

required=false表示该值可不存在,可为空。也可以作用于@Autowired表示该bean不是必须的,可不存在,可为空。

@PathVariable
路径变量,获取RequestMapping中占位符的值

@RequestMapping("/user/{uid}")
public String getUserById(@PathVariable Integer id){
//do something
}

@RequestBody
可以接收json格式的数据(应该可省略,直接写实体类目前可以直接转换)

public DbBook findBookByName(@RequestBody DbBook book)

接收字符串(不能组成一个实体类,所以不能用实体类接收的情况)

public void deleteBookById(@RequestBody Map<String, String> map)

@RequestBody接收不同的对象

  1. 创建一个新的entity,将两个entity都进去。
  2. 用Map<String, Object>接受request body,自己反序列化到各个entity中。
  3. 实现自己的HandlerMethodArgumentResolver

@ModelAttribute
和实体类绑定

public String modelAttributeTest(@ModelAttribute User user)

注:multipart/form-data(二进制文件)@RequestBody不能处理这种格式的数据。
application/json、application/xml等格式的数据,必须使用@RequestBody来处理。

五、全局异常处理

@ControllerAdvice
control增强器

import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.*;
import org.springframework.ui.Model;
import java.util.HashMap;
import java.util.Map;

/**
 * controller 增强器,作用于所有有效的control
 */
@ControllerAdvice
public class MyControllerAdvice {

    /**
     * 应用到所有@RequestMapping注解方法,在其执行之前初始化数据绑定器
     * @param binder
     */
    @InitBinder
    public void initBinder(WebDataBinder binder) {}

    /**
     * 把值绑定到Model中,使全局@RequestMapping可以获取到该值
     * @param model
     */
    @ModelAttribute
    public void addAttributes(Model model) {
        model.addAttribute("author", "Magical Sam");
    }

    /**
     * 全局异常捕捉处理
     * @param ex
     * @return
     */
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public Map errorHandler(Exception ex) {
        Map map = new HashMap();
        map.put("code", 100);
        map.put("msg", ex.getMessage());
        return map;
    }

}

@ExceptionHandler(Exception.class):
标注在方法上,遇到这个异常就执行以下方法

六、JPA

  • 建表时的附加语句,可以用来指定类型,默认值等
  1. tinyint类型的默认值@Column(name="state",columnDefinition="tinyint default 0")
  2. varchar(128),非空@Column(name = "Email",columnDefinition="varchar(128) not null")

当String类型不够用时可以指定属性在数据库中的类型为text

@Column(name = "Remark",columnDefinition="text")
  • uuid,见jpa主键生成策略

  • query执行sql语句

 @Query("from User u where u.name=:name")
    User findUser(@Param("name") String name);

@Query("select * from User u where u.name like :first and u.age>:age")
List<User> findByNameLikeAndAgeGreaterThan(@Param("first")String firstName,@Param("age")Integer age);

七、值注入

  • @Value("${key}")

通过key注入配置文件中的value

  • @Value("${myValue:#{null}}")注入非必填的
    @Value 想要非必填 required false

  • set上加

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