SpringBoot常用注解及介绍

SpringBoot常用注解

@SpringBootApplication

  • 申明让spring boot自动给程序进行必要的配置,这个配置等同于:@Configuration,@EnableAutoConfiguration和@ComponentScan三个配置

  • 通常用在启动类中

@ResponseBody

  • 表示该方法的返回结果直接写入HTTP response body中,一般在异步获取数据时使用,用于构建RESTful的api。

@Controller

  • 用于定义控制器类,在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口(service层)。

@RestController

  • 用于标注控制层组件,@ResponseBody和@Controller的合集。

@RequestMapping

  • 提供路由信息,负责URL到Controller中的具体函数的映射。

  • 表示该控制器处理所有“/path”的url请求。

  • RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。

  • 用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。该注解有六个属性:

  1. parmas:指定request中必须包含某些参数值,才让该方法处理。
  2. headers:指定request中必须包含某些指定的header值,才能让该方法处理请求。
  3. value:指定请求的实际地址
  4. method:指定请求的method类型
  5. consumes:指定处理请求的提交内容类型,Content-Type
  6. produces:指定返回的内容类型,仅当request请求头中的Accept类型包含该指定类型才返回。

@RequestParam

  • 用在方法的参数前面。

@PathVariable

  • 路径变量

@RequestHeader

  • 从请求的header中获取参数

@ModelAttribute

  • 在请求Controller时,首先会通过该注解标识的方法,可以在该方法中做一些预处理操作

  • 例如:通过@ModelAttribute注解方法获取token,并解析数据,然后在想要获取用户信息的Controller方法中再次使用@ModelAttribute注解获取处理好的用户数据。

    @ModelAttribute
    public User getUser(@RequestHeader("Authorization") String token) {
        User user = (User) redisUtil.getCacheObject(token);
        return user;
    }
    
    @GetMapping("status")
        public Result getAttendanceStatus(@ModelAttribute User user) {
            return Result.success(MongodbUtil.find(new AttendanceDto(), new String[]{"userId"},
                    new Object[]{user.getUserId()}, Constant.MONGO_COLLECTION_RUNNING)
                    .size() % 2 == 0 ? "start" : "end");
        }
    
  • 如果希望在每个Controller中都获得操作之后的数据,可以创建一个BaseController,然后让其它Controller以继承的方式进行使用。

@EnableAutoConfiguration

  • Spring boot自动配置,尝试根据你添加的jar依赖自动配置你的spring应用

@ComponentScan

  • 表示将该类自动发现扫描组件。如果扫描到有@Component、@Controller、@Service等这些注解的类,并注册Bean,可以自动收集所有的spring组件,包括@Configuration类。

@Configuration

  • 相当于传统的xml配置文件,如果有些第三方库需要用到xml文件,建议仍然通过@Configuration类作为项目的配置主类–可以使用@ImportResource注解加载xml配置文件。

@Import

  • 用来导入其它配置类。

@ImportResource

  • 用来加载xml配置文件。

@Autowired

  • 自动导入依赖的bean。自动导入依赖的bean。byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。当加上(required=false)时,就算找不到bean也不报错。

@Service

  • 一般用于修饰service层的组件。

@Repository

  • 使用@Repository注解可以确保dao或者repositories提供异常转译,这个注解修饰的dao或者repositories类会被ComponetScan发现并配置,同时也不需要为它们提供xml配置项。

@Bean

  • 用@Bean标注方法等价于Xml中配置的bean

@Value

  • 注入spring boot application.properties配置的属性的值。

@Inject

  • 等价于morende@Autowired,只是没有required属性

@Component

  • 泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。

@Qualifier

  • 当有多个同一类型的bean时,可以用@Qualifier(“name”)来指定。与@Atuowired配合使用。@Qualifier限定描述符除了能根据名字进行注入,但能进行更细粒度的控制如何选择侯选者
@Autowired
@Qualifier(value="demoInfoService")
private DemoInfoService demoInfoService;

@Resource

  • name,type:没有指定的话,默认byName。

@ControllerAdvice

  • 包含@Component。可以被扫描到,同一异常处理。

@ExceptionHandler(Exception.class)

  • 用在方法上面表示遇到这个异常就指定以下方法。

JPA注解

@Entity

  • @Table(name="")表明这是一个实体类。一般用于jpa这两个注解一般一块使用,但是如果表名和实体类名相同的话,@Table可以省略。

@MappedSuperClass

  • 用在确定是父类的entity上。父类的属性子类可以继承。

@NoRepositoryBean

  • 一般用作父类的repository,有这个注解,spring不会去实例化该repository。

@Column

  • 如果字段名与列名相同,则可以省略。

@Id

  • 表示该属性为主键

@GeneratedValue(strategy=GenerationType.SEQUENCE,generator=“repair_seq”)

  • 表示主键生成策略是sequence,指定sequence的名字是repair_seq

@SequenceGeneretor(name=“repair_seq”,sequenceName=“seq_repair”,allocationSize=1)

  • name为sequence的名称,以便使用,sequenceName为数据库的sequence名称,两个名称可以一致。

@Transient

  • 表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。如果一个属性并非数据库表的字段映射,就务必将其表示为@Transient,否则ROM框架默认其注解为@Basic,@Basic(fetch=FetchType.LAZY):标记可以指定实体属性的加载方式。

@JsonIgnore

  • 作用是jison序列化时将java bean中的一些属性忽略掉,序列化和反序列化都受影响。

@JoinColumn(name=“loginId”)

  • 一对一,本表中指向另一个表的外键。一对多:另一个表指向本表的外键。

@OneToOne、@OneToMany、@ManToOne

  • 对应hibernate配置文件中的一对一、一对多、多对一。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值