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