springmvc+springboot常用注解简单说明

这里简单说而已

@SpringbootApplication：启动类

@Controller、@RestController（@ResponseBody+@Controller组合）：控制层

@ResponseBody：讲返回的数据以json格式发送

@RequestBody：，主要用实体类进行接收，前端发来json数据转换为pojo实体对象。（不适用于get请求）

@RequestParam：适用于任何请求，主要用来处理接收简单类型的数据，例（有两个属性value、required）

接收名为username的值，且不用一定有值（可以为空等，设置为true则不能为空）

@GetMapping("/testA")
    public String testA(@RequestParam(value = "username",required = false)String username ){
        return "--------testA";
    }

总结一下：@RequestBody和@RequestParam的使用注意

在GET请求中，不能使用@RequestBody。

在POST请求，可以使用@RequestBody和@RequestParam，但是如果使用@RequestBody，对于参数转化的配置必须统一。

举个例子，在SpringMVC配置了HttpMessageConverters处理栈中，指定json转化的格式，如Date转成‘yyyy-MM-dd’,则参数接收对象包含的字段如果是Date类型，就只能让客户端传递年月日的格式，不能传时分秒。因为不同的接口，它的参数可能对时间参数有不同的格式要求，所以这样做会让客户端调用同事对参数的格式有点困惑，所以说扩展性不高。

如果使用@RequestParam来接受参数，可以在接受参数的model中设置@DateFormat指定所需要接受时间参数的格式。

另外，使用@RequestBody接受的参数是不会被Servlet转化统一放在request对象的Param参数集中，@RequestParam是可以的。

@ComponentScan：扫描注解

@Configuration ：配置类

@Component ：类注入容器

@Param：一般用在mybatis的sql参数

mybatis提供了一个使用注解来参入多个参数的方法，这种方法需要在接口的参数上添加@Param注解。

举个例子：

    /**
     * 更新学生信息
     * @param student
     * @return
     */
    int updateInfo(@Param("student") Student student);

在这个updateInfo的方法中需要传入多个参数，那么在进行mybatis配置的时候，没有办法同事配置多个参数，所以需要@Param这个注解来绑定参数对象。student这个参数中包含了三个对象，用@Param来绑定参数并命名为"student"。并且在mapper.xml文件中调用时，对逐个参数在调用时，要加上 student. 的前缀。如下所示：

    <update id="updateInfo">
        UPDATE test_student SET name=#{student.name},age=#{student.age} WHERE id=#{student.id}
    </update>

注意事项：在使用@Param来注解时，如果使用#{ } 或者 ${ } 的方式都可以，但如果不是用@Param注解时，则必须使用#{ }方式。（当然@Param也可以作为单个普通类型的参数传入）

@ControllerAdvice    使一个Controller成为全局的异常处理类, 类中用ExceptinHandler方法注解的方法可以处理所有Controller发生的异常。

@ExceptionHandler    注解到方法上, 出现异常时会执行该方法。

@PathVariable 用于接收路径参数，比如@RequestMapping(“/hello/{name}”)申明的路径，将注解放在参数中前，即可获取该值，通常作为Restful的接口实现方法。

 

注解本身没有功能的，就和xml一样。注解和xml都是一种元数据，元数据即解释数据的数据，这就是所谓配置。

本文主要Spring和SpringMVC相关常用的注解。

Spring部分

1.声明bean的注解
@Component 组件，没有明确的角色
@Service 在业务逻辑层使用（service层）
@Repository 在数据访问层使用（dao层）
@Controller 在展现层使用，控制器的声明（C）

2.注入bean的注解
@Autowired：由Spring提供
@Inject：由JSR-330提供
@Resource：由JSR-250提供
都可以注解在set方法和属性上，推荐注解在属性上（一目了然，少写代码）。


3.java配置类相关注解
@Configuration 声明当前类为配置类，相当于xml形式的Spring配置（类上）
@Bean 注解在方法上，声明当前方法的返回值为一个bean，替代xml中的方式（方法上）
@Configuration 声明当前类为配置类，其中内部组合了@Component注解，表明这个类是一个bean（类上）
@ComponentScan 用于对Component进行扫描，相当于xml中的（类上）
@WishlyConfiguration 为@Configuration与@ComponentScan的组合注解，可以替代这两个注解


4.切面（AOP）相关注解
Spring支持AspectJ的注解式切面编程。
@Aspect 声明一个切面（类上） 
使用@After、@Before、@Around定义建言（advice），可直接将拦截规则（切点）作为参数。
@After 在方法执行之后执行（方法上） 
@Before 在方法执行之前执行（方法上） 
@Around 在方法执行之前与之后执行（方法上）
@PointCut 声明切点 
在java配置类中使用@EnableAspectJAutoProxy注解开启Spring对AspectJ代理的支持（类上）


5.@Bean的属性支持
@Scope 设置Spring容器如何新建Bean实例（方法上，得有@Bean） 
其设置类型包括：
Singleton （单例,一个Spring容器中只有一个bean实例，默认模式）, 
Protetype （每次调用新建一个bean）, 
Request （web项目中，给每个http request新建一个bean）, 
Session （web项目中，给每个http session新建一个bean）, 
GlobalSession（给每一个 global http session新建一个Bean实例）
@StepScope 在Spring Batch中还有涉及
@PostConstruct 由JSR-250提供，在构造函数执行完之后执行，等价于xml配置文件中bean的initMethod
@PreDestory 由JSR-250提供，在Bean销毁之前执行，等价于xml配置文件中bean的destroyMethod



6.@Value注解

@Value 为属性注入值（属性上） 
支持如下方式的注入： 

注入普通字符

Java code?

1 2	@Value("Michael Jackson") String name;

注入操作系统属性

Java code?

1 2	@Value("#{systemProperties['os.name']}") String osName;

注入表达式结果

Java code?

1 2	@Value("#{ T(java.lang.Math).random() * 100 }") String randomNumber;

注入其它bean属性

Java code?

1 2	@Value("#{domeClass.name}") String name;

注入文件资源

Java code?

1 2	@Value("classpath:com/hgs/hello/test.txt") String Resource file;

注入网站资源

Java code?

1 2	@Value("http://www.cznovel") Resource url;

注入配置文件

Java code?

1 2	@Value("${book.name}") String bookName;

注入配置使用方法： 
① 编写配置文件（test.properties）

Plain Text code?

1	book.name=《三体》

② @PropertySource 加载配置文件(类上)

Java code?

1	@PropertySource("classpath:com/hgs/hello/test/test.propertie")

③ 还需配置一个PropertySourcesPlaceholderConfigurer的bean。



7.环境切换
@Profile 通过设定Environment的ActiveProfiles来设定当前context需要使用的配置环境。（类或方法上）
@Conditional Spring4中可以使用此注解定义条件话的bean，通过实现Condition接口，并重写matches方法，从而决定该bean是否被实例化。（方法上）


8.异步相关
@EnableAsync 配置类中，通过此注解开启对异步任务的支持，叙事性AsyncConfigurer接口（类上）
@Async 在实际执行的bean方法使用该注解来申明其是一个异步任务（方法上或类上所有的方法都将异步，需要@EnableAsync开启异步任务）


9.定时任务相关
@EnableScheduling 在配置类上使用，开启计划任务的支持（类上）
@Scheduled 来申明这是一个任务，包括cron,fixDelay,fixRate等类型（方法上，需先开启计划任务的支持）



10.@Enable*注解说明
这些注解主要用来开启对xxx的支持。 
@EnableAspectJAutoProxy 开启对AspectJ自动代理的支持
@EnableAsync 开启异步方法的支持
@EnableScheduling 开启计划任务的支持
@EnableWebMvc 开启Web MVC的配置支持
@EnableConfigurationProperties 开启对@ConfigurationProperties注解配置Bean的支持
@EnableJpaRepositories 开启对SpringData JPA Repository的支持
@EnableTransactionManagement 开启注解式事务的支持
@EnableTransactionManagement 开启注解式事务的支持
@EnableCaching 开启注解式的缓存支持



11.测试相关注解
@RunWith 运行器，Spring中通常用于对JUnit的支持

Java code?

1	@RunWith(SpringJUnit4ClassRunner.class)

@ContextConfiguration 用来加载配置ApplicationContext，其中classes属性用来加载配置类

Java code?

1	@ContextConfiguration(classes={TestConfig.class})

SpringMVC部分
@EnableWebMvc 在配置类中开启Web MVC的配置支持，如一些ViewResolver或者MessageConverter等，若无此句，重写WebMvcConfigurerAdapter方法（用于对SpringMVC的配置）。
@Controller 声明该类为SpringMVC中的Controller
@RequestMapping 用于映射Web请求，包括访问路径和参数（类或方法上）
@ResponseBody 支持将返回值放在response内，而不是一个页面，通常用户返回json数据（返回值旁或方法上）
@RequestBody 允许request的参数在request体中，而不是在直接连接在地址后面。（放在参数前）
@PathVariable 用于接收路径参数，比如@RequestMapping(“/hello/{name}”)申明的路径，将注解放在参数中前，即可获取该值，通常作为Restful的接口实现方法。
@RestController 该注解为一个组合注解，相当于@Controller和@ResponseBody的组合，注解在类上，意味着，该Controller的所有方法都默认加上了@ResponseBody。
@ControllerAdvice 通过该注解，我们可以将对于控制器的全局配置放置在同一个位置，注解了@Controller的类的方法可使用@ExceptionHandler、@InitBinder、@ModelAttribute注解到方法上， 
这对所有注解了 @RequestMapping的控制器内的方法有效。
@ExceptionHandler 用于全局处理控制器里的异常
@InitBinder 用来设置WebDataBinder，WebDataBinder用来自动绑定前台请求参数到Model中。
@ModelAttribute 本来的作用是绑定键值对到Model里，在@ControllerAdvice中是让全局的@RequestMapping都能获得在此处设置的键值对。 

----------------------------------------------------------------------------------------------------------------------------------------------------
spring和springMVC的注解重复的都是通用的
 

总结下：

一般接收参数用@RequestParam（支持任何请求），@RequestBody如果用实体类接收时注意实体类的属性的统一，例如时间的格式（此时处理可以参考https://blog.csdn/TROY_Musou/article/details/79578727）。mybatis一般要用@Param传参

https://blog.csdn/m0_37826012/article/details/105294554

（对于date类型，注意 Date 类的 set 方法，前端传的时间参数必须是 timeInMillis 的 long 类型才能转换，而且这里需要设置 ContentType 为 application/json）