欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

SpringBoot常用注解(复习)

程序员文章站 2022-06-06 10:33:19
...

@SpringBootApplication

是SpringBoot程序的入口

  • @SpringBootApplication = @Configuration + @EnableAutoConfiguration + @ComponentScan
  • @Configuration : 声明配置类,可以使用 @Component注解替代,不过使用Configuration注解声明配置类更加语义化,允许在 Spring 上下文中注册额外的 bean 或导入其他配置类
  • @EnableAutoConfiguration : 启用 SpringBoot 的自动配置机制
  • @ComponentScan : 扫描被@Componentb及其子类 (@Service,@Controller,@Repository)注解的 bean,注解默认会扫描该类所在的包下所有的类。

@ComponentScan

@Autowired

  • 可以让 Spring 容器帮我们自动装配 bean。

@Component(@Repository,@Service, @Controller)

  • 把这个类交由spring容器管理,启动容器后注入bean,相当于配置文件中的,与@Autowired配合,用此注解的类可以被 @Autowired 注解自动装配bean
  • @Repository : 对应持久层即 Dao 层,主要用于数据库相关操作。
  • @Service : 对应服务层,主要涉及一些复杂的逻辑,需要用到 Dao 层。
  • @Controller : 对应 Spring MVC 控制层,接受用户请求并调用 Service 层返回数据给前端页面。

这里有详细点的解释
https://zhidao.baidu.com/question/262208247.html

@Configuration

用来声明配置类,可以使用 @Component注解替代,不过使用Configuration注解声明配置类更加语义化。

@Bean

作用于方法级别,在@Configuration或@Component配置类下
@Bean注解用于告诉方法,产生一个Bean对象,然后这个Bean对象交给Spring管理

例如使用mybatis-plus的分页插件的时候:

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;
/*没有这个插件的话,实现不了分页查询,一次查10条*/
@Configuration
public class MybatisPlusConfig {
        @Bean
        public PaginationInterceptor paginationInterceptor(){
            return new PaginationInterceptor();
        }
}

@RestController

  • @aaa@qq.comaaa@qq.com
    表示这是个REST 风格的控制器 bean,返回 JSON 或 XML 形式数据,填入 HTTP 响应体中
  • @Controller
    SpingMvc的注解,控制器类,配合视图解析器,用于返回一个视图
  • @ResponseBody
    将controller的方法返回的对象通过适当的转换器转换为JSON数据或者XML格式,不通过视图解析器,
    直接写入到 HTTP 响应体的body区,

@RequestMapping

注解映射请求路径
可以使用@RequestMapping注解来将请求URL映射到整个类上或某个特定的方法上(类级别的注解负责将一个特定(或符合某种模式)的请求路径映射到一个控制器上,同时通过方法级别的注解来细化映射,即
根据特定的HTTP请求方法(GET、POST 方法等)、HTTP请求中是否携带特定参数等条件,将请求映射到匹配的方法上)

  • 限制请求方法的URL 映射
@RequestMapping(value="/hello", method=RequestMethod.POST)
  • 限制请求参数的URL 映射
@RequestMapping(value="/user/show", params="userId")

即必须携带userId参数

项目中可以不再使用@RequestMapping而是使用更为细化的@GetMapping、@PostMapping等

@GetMapping

是一个组合注解aaa@qq.com(method = RequestMethod.GET),使用该注解将HTTP Get请求 映射到 特定的处理方法上.用于响应客户端Get请求获取资源的方法

@PostMapping

是一个组合注解aaa@qq.com(method = RequestMethod.Post),使用该注解将HTTP Post请求映射到 特定的处理方法上。用于响应客户端Put请求提交资源的方法

@PutMapping

是一个组合注解aaa@qq.com(method = RequestMethod.Put),使用该注解将HTTP Put请求映射到 特定的处理方法上。用于响应客户端put请求更新资源的方法

@Data

要使用 @Data 注解要先引入lombok,是一个工具类库,可以用简单的注解形式来简化代码,省去代码中大量的get()、 set()、 toString()等方法,提高开发效率。

常规写法:

public class Student {
    Integer Id;
    String  name;
    
    public Student() {
    }
    
    public Integer getId() {
        return Id;
    }

    public void setId(Integer id) {
        Id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "Student{" +
                "Id=" + Id +
                ", name='" + name + '\'' +
                '}';
    }
}

引入lombok,就几行代码

import lombok.Data;

@Data
public class Student {
    Integer Id;
    String  name;
}

提供了以下方法:

SpringBoot常用注解(复习)

参考链接:
https://blog.csdn.net/zalan01408980/article/details/82904126
https://zhuanlan.zhihu.com/p/96752990

@JsonIgnore

作用在类的属性,在实体类向前台返回数据时用来忽略不想传递给前台的属性或接口。

@JsonFormat

把相关的json 数据按照一定的标准格式化
例如把数据库中date类型的日期格式化成"yyyy-MM-dd HH:mm:ss",方便前端展示数据

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "Asia/Shanghai")
    private LocalDateTime publishDate;
  • 数据库相关

@Column

声明字段。标识实体类中属性与数据表中字段的对应关系。
如下例子中,设置实体类属性 userName 对应的数据库字段名为 user_name

@Column(name = "user_name")
private String userName;

@TableId

数据表的主键标识,放在属性上表明这个字段是表的主键

 @TableId(value="id",type= IdType.AUTO)
    Long id;

mybtis-plus框架中主键默认是插入生成一个随机长数字字符串(编码不同可能结尾带有字母),
要想数据库主键自增,就要设置type= IdType.AUTO

@TableField

mybatis-plus注解,加在实体类属性上,表示该属性不为数据库表字段
mapper.xml的sql中联表查询时,返回的字段实体类中没有时,就可以在此实体类中增加个属性,并加此注解,即可用此实体类接受数据;而添加时,就算此属性有数据也不会去匹配字段添加,

 @TableField(exist = false)
    Integer articleCounts;

当实体类属性有数据库对象中不存在的属性时,如果不添加此注解,MyBatis-plus 内部自动转成的sql语句会查询该字段并引发错误"unknown colum"
SpringBoot常用注解(复习)

相关标签: springboot spring