Spring+Spring Boot+Mybatis框架注解解析

Restful 风格下的Spring Boot的注解开发

电商网站经常用到的restful风格 ，只是一种开发思想，不是开发框架，现在的技术并没有完全实现restful风格。
restful风格是一种架构理念，完美的诠释了http协议
restful 方式需要配置一套restful风格的前端控制器，用/来标识url-pattern
RequestMapping(value="/ViewItems/{id}" String id) java类里面使用@PathVariable("id") 注解进行参数绑定String id或者绑定java Bean的bean属性

@SpringBootApplication

Springboot 提供了统一的注解@SpringBootApplication来替代这三个注解@Configuration、@EnableAutoConfiguration、@ComponentScan，简化程序的配置。

@EnableAutoConfiguration

@EnableAutoConfiguration：能够自动配置spring的上下文，试图猜测和配置你想要的bean类，通常会自动根据你的类路径和你的bean定义自动配置。

@ComponentScan

@ComponentScan：会自动扫描指定包下的全部标有@Component的类，并注册成bean，当然包括@Component下的子注解@Service,@Repository,@Controller。

@Configuration

@Configuration标注在类上，相当于把该类作为spring的xml配置文件中的<beans>，作用为：配置spring容器(应用上下文)，加载配置xml文件的注解。用@Configuration注解该类，等价与XML中配置beans；用@Bean标注方法等价于XML中配置bean。

@EnableWebMvc

想要以Java形式定制默认的配置，你可以简单的实现WebMvcConfigurer接口，或者继承WebMvcConfigurerAdapter并重写需要的方法：
@Configuration
class WebMvcConfig extends WebMvcConfigurerAdapter {
　　@Override
　　public void addResourceHandlers(ResourceHandlerRegistry registry) {
　　　　registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
　　　　registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
　　}}

@Override

Override是一个marker annotation类型，它被用作标注方法。它说明了被标注的方法重载了父类的方法，起到了断言的作用。 如果写错，编译器可以检测出哪些是错误的，这样能保证你的确重写的方法正确.

@Validated（value={}）

这个注解指的是分组校验,与BindingResult 配对出现, ModelandView 的 Model对象可以将error的信息返回给界面。

@ModelAttribute（""）

注解回显到request里面的key
处理回显信息：　　不管你输入什么，正确都提交，错误都回显，同时还可以将返回值返回给界面，最简单的回显跟数据类型的回显，直接使用model.addAttribute("allErrors",allErrors);
　　配置图片的虚拟目录跟访问路径，tomcat双击->model->选在第二个add external web module

@Autowired

Spring 2.5 引入了 @Autowired 注释，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。 通过 @Autowired的使用来消除 set ，get方法。

@RequestMapping("fileUpload")

注解为控制器指定可以处理哪些特定的 URL 请求。

@ApiOperation和@ApiParam

@ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response= “接口返回参数类型”, notes = “接口发布说明”；其他参数可参考源码，不是spring自带的注解，而是swagger里com.wordnik.swagger.annotations.ApiOperation;
@ApiParam(required = “是否必须参数”, name = “参数名称”, value = “参数具 体描述”。

@Api

修饰整个类，描述Controller的作用。

@ApiOperation

描述一个类的一个方法，或者说一个接口。

@ApiModel

用Model对象来接收参数。

@ApiParam

@ApiParam(value = "token", required = true) @RequestParam String token
Web前端/移动端HTTP请求方式：直接把参数附带到URL后面，或者用AJAX方法，表单提交。

@ApiProperty

用对象接收参数时，描述对象的一个字段。

@ApiResponse

HTTP响应其中1个请求以及参数描述。

@ApiResponses

HTTP响应整体描述。

@ApiModelProperty

对象属性 @ApiModelProperty 用在出入参数对象的字段上。

@RestController

@RestController注解是它继承自@Controller注解。4.0之前的版本，spring MVC的组件都使用@Controller来标识当前类是一个控制器servlet。
使用这个特性，我们可以开发REST服务的时候不需要使用@Controller而专门的@RestController。
注解本身使用@Controller和@ResponseBody注解。使用了这个注解的类会被看作一个controller使用@RequestMapping的方法自己还有一个默认的@ResponseBody注解。@Api 用于controller类上 用于协议集描述@ApiOperation 用在controller的方法上 用于协议集描述@ApiResponses	用在controller的方法上 属于Response集@ApiResponse 用在 @ApiResponses里边 属于Response集@ApiImplicitParams 用在controller的方法上 属于非对象参数集@ApiImplicitParam 用在@ApiImplicitParams的方法里边 属于非对象参数集@ApiModel 用在返回对象类上 描述返回对象的意义

@component

把普通pojo实例化到spring容器中，相当于配置文件中的<bean id="" class=""/>

@RequestBody

该注解用于读取Request请求的body部分数据，使用系统默认配置的HttpMessageConverter进行解析，然后把相应的数据绑定到要返回的对象上 ,再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上

@Data

注解在类上, 为类提供读写属性, 此外还提供了 equals()、hashCode()、toString() 方法

@Builder

注解在类上, 为类提供一个内部的 Builder

@Synchronized

注解在方法上, 为方法提供同步锁

@Log4j

注解在类上, 为类提供一个属性名为 log 的 log4j 的日志对象

@Slf4j

注解在类上, 为类提供一个属性名为 log 的 log4j 的日志对象

@Service

用于标注业务层组件

@Controller

用于标注控制层组件（如struts中的action）

@Repository

用于标注数据访问组件，即DAO组件

@Component

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

@Autowired

@Qualifier("chinese")
当接口存在两个实现类的时候必须使用@Qualifier指定注入哪个实现类，否则可以省略，只写@Autowired。
<mvc:annocation-driven/>注解形式的可以不用配置json转换器，直接使用
@ResponseBody注解 可以设置json跟Bean 之间的转换 ： 该注解用于将Controller的方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区

@ModelAttribute

在方法定义上使用 @ModelAttribute 注解：Spring MVC 在调用目标处理方法前，会先逐个调用在方法级上标注了@ModelAttribute的方法，在方法的入参前使用 @ModelAttribute 注解：可以从隐含对象中获取隐含的模型数据中获取对象，再将请求参数 –绑定到对象中，再传入入参将方法入参对象添加到模型中

@RequestParam

在处理方法入参处使用 @RequestParam 可以把请求参 数传递给请求方法

@PathVariable

绑定 URL 占位符到入参

@ExceptionHandler

注解到方法上，出现异常时会执行该方法

@ControllerAdvice

使一个Contoller成为全局的异常处理类，类中用@ExceptionHandler方法注解的方法可以处理所有Controller发生的异常

@ResponseBody

该注解用于将Controller的方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区。 使用时机： 返回的数据不是html标签的页面，而是其他某种格式的数据时（如json、xml等）使用当我们在Controller上标注了@RestController，这样相当于Controller的所有方法都标注了@ResponseBody
@responseBody注解的作用是将controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML数据，需要注意的呢，在使用此注解之后不会再走试图处理器，而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。
@RequestMapping("/login")

　　@ResponseBody
　　public User login(User user){
　　　　return user;
　　}
　　User字段：userName pwd
　　那么在前台接收到的数据为：‘{"userName":"xxx","pwd":"xxx"}‘

　　效果等同于如下代码：
　　@RequestMapping("/login")
　　public void login(User user, HttpServletResponse response){
　　　　response.getWriter.write(JSONObject.fromObject(user).toString());
　　}

细节:Google的一个json的jar包，随时将对象封装json返回。
Gson gson = new Gson();
String json = gson.toJson(对象);

@Param

1，使用@Param注解
当以下面的方式进行写SQL语句时：
    @Select("select column from table where userid = #{userid} ")
    public int selectColumn(int userid);
当你使用了使用@Param注解来声明参数时，如果使用 #{} 或 ${} 的方式都可以。
    @Select("select column from table where userid = ${userid} ")
    public int selectColumn(@Param("userid") int userid);
当你不使用@Param注解来声明参数时，必须使用使用 #{}方式。如果使用 ${} 的方式，会报错。
    @Select("select column from table where userid = ${userid} ")
    public int selectColumn(@Param("userid") int userid);
2，不使用@Param注解
不使用@Param注解时，参数只能有一个，并且是Javabean。在SQL语句里可以引用JavaBean的属性，而且只能引用JavaBean的属性。
    // 这里id是user的属性
    @Select("SELECT * from Table where id = ${id}")
    Enchashment selectUserById(User user);

《忆》

华丽的服装
柔美的线条
只为证明你来过
微笑的表情
脆弱的生命
只为暗示你还活着
在千里之外的你
耳语的是什么
床前的灯
透漏着些什么
路边的人群
又在低头思索哪一个
从前的你我
千年以后还记得住什么
看见过奔腾的沙漠
体会过无声的黄河
感受时间的尽头
重现恶魔的梦魇
快乐漫漫星空
悲伤缕缕光芒
黑夜与黎明的交替
是善与恶的更迭
冰与火的重生
美轮美奂
只为意

原文地址：https://www.cnblogs.com/jueyushanlang/p/8366453.html

时间： 2024-11-04 18:11:13

Spring+Spring Boot+Mybatis框架注解解析的相关文章

【spring boot+mybatis】注解使用方式（无xml配置）设置自动驼峰明明转换（），IDEA中xxDao报错could not autowire的解决方法

最近使用spring boot+mybatis,使用IntelliJ IDEA开发,记录一些问题的解决方法. 1.在使用@Mapper注解方式代替XXmapper.xml配置文件,使用@Select等注解配置sql语句的情况下,如何配置数据库字段名到JavaBean实体类属性命的自动驼峰命名转换? 使用spring boot后,越来越喜欢用注解方式进行配置,代替xml配置文件方式.mybatis中也可以完全使用注解,避免使用xml方式配置mapper.(参考  springboot(六):如何优

详解spring boot mybatis全注解化

本文重点介绍spring boot mybatis 注解化的实例代码 1.pom.xml //引入mybatis <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>1.3.0</version> </dependency> //

spring、spring mvc、mybatis框架整合基本知识

学习了一个多月的框架知识了,这两天很想将它整合一下.网上看了很多整合案例,基本都是基于Eclipse的,但现在外面公司基本都在用Intellij IDEA了,所以结合所学知识,自己做了个总结,有不足之处欢迎指正. 首先,我是参考了http://blog.csdn.net/zhshulin/article/details/37956105这篇做的Intellij IDEA翻版.Intellij IDEA的许多操作方式与习惯与eclipse区别很大,所以很容易走入误区.直接上操作吧. 1.基本概念

IDEA下创建Maven项目，并整合使用Spring、Spring MVC、Mybatis框架

项目创建 本项目使用的是IDEA 2016创建.项目使用Spring 4.2.6,Mybatis3.4.0,Tomcat使用的是Tomcat8,数据库为MySQL. 首先电脑安装Maven,接着打开IDEA新建一个project,选择Maven,选择图中所选项,下一步. 填写好GroupId和ArtifactId,GroupId在公司中一般都是域名的逆序,ArtifactId用来标明该项目是用来做什么的,接着下一步. 添加一个archetypeCatalog,值为internal可以加速项目的创

spring，spring mvc，mybatis 常用注解

文章来源:https://www.cnblogs.com/hello-tl/p/9209063.html  0.在spring,soring mvc, mybistis 中的常用注解有一下 <!-- 扫描指定的包中的类上的注解,常用的注解有: --> <!-- @Controller 声明Action组件 --> <!-- @Service 声明Service组件 @Service("xxxService") --> <!-- @Reposit

Spring mvc 数据验证框架注解

@AssertFalse 被注解的元素必须为false@AssertTrue 被注解的元素必须为false@DecimalMax(value) 被注解的元素必须为一个数字,其值必须小于等于指定的最小值@DecimalMin(Value) 被注解的元素必须为一个数字,其值必须大于等于指定的最小值@Digits(integer=, fraction=) 被注解的元素必须为一个数字,其值必须在可接受的范围内@Future 被注解的元素必须是日期,检查给定的日期是否比现在晚.@Max(value) 被注

Mybatis框架中：Check syntax #{property|(expression), var1=value1, var2=value2, ...}

异常代码: @Insert("insert into t_member(m_id,m_name,m_phone,m_level,m_card_no) values(#{m_id},#{m_name),#{m_phone},#{m_level},#{m_card_no})") 在使用Mybatis框架的同时,我们要注意很多细节,不能因为粗心而导致程序的单元测试不能得到正确的测试效果,从而耽误我们对程序代码的继续编写 上述代码的错误其实很明显,但是我们有时候会出现一种名为:"睁眼

springMVC,spring,mybatis全注解搭建框架--第一步，让框架跑起来

自己从事java开发工作也有一年多了,自己却没有亲手搭建一个完整的框架.于是今天自己动手搭建一个,过程中遇到一些问题,倒腾了大半天终于搞定了. 现在给大家分享一下过程,自己也记录下来,以后学习参考使用. 我采用全注解的方式去搭建springMVC,spring,mybatis框架,同时自己也可以去配置xml,但是主要还是通过注解的方式来实现.参考的网上其它大神分享的方法,多多少少有些地方写的不清楚,也并不是完全通过注解去实现的. springboot可以真正说是零配置吧,后面我将给大家演示spr

spring boot中mybatis使用注解进行模糊查询

小白一枚,spring boot 2.0.5在使用mybatis进行注解模糊查询时遇到一些低级的错误,现记录下来错误示例:"select * from user where name like \""#{name}\""这个错误报Parameter index out of range (1 > number of parameters, which is 0): 经过百度查询其它的得到这条sql语句,虽然能查出来,但是是全部数据都查出来了"