框架中常见的注解分析

按照注解的来源，也是分为3类
1. 内置注解 如@Override，@Deprecated 等等
2. 第三方注解，如Hibernate, Struts等等
3. 自定义注解，如fahibernate的自定义注解

在工作中，大部分都使用的是第三方注解。那么接下来就介绍一些常用的第三方注解如:@RequestMapping、@ResponseBody、@Autowired 、@Scope、@Controller、@Service、@Repository、@Component、@RequiresPermission等等.

　　

@RequestMapping

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

<1>用于类上：表示类中的所有响应请求的方法都是以该地址作为父路径。

  • requestmapping有六个属性，可以分为以下三类:

<1>value、method:

1.value : 指定请求的实际地址（可以是URI Template 模式）;

默认RequestMapping("....str...")即为value的值；

 1 @Controller
 2 @RequestMapping("/appointments")
 3 public class AppointmentsController {
 4
 5     private AppointmentBook appointmentBook;
 6
 7     @Autowired
 8     public AppointmentsController(AppointmentBook appointmentBook) {
 9         this.appointmentBook = appointmentBook;
10     }
11
12     @RequestMapping(method = RequestMethod.GET)
13     public Map<String, Appointment> get() {
14         return appointmentBook.getAppointmentsForToday();
15     }
16
17     @RequestMapping(value="/{day}", method = RequestMethod.GET)
18     public Map<String, Appointment> getForDay(@PathVariable @DateTimeFormat(iso=ISO.DATE) Date day, Model model) {
19         return appointmentBook.getAppointmentsForDay(day);
20     }
21
22     @RequestMapping(value="/new", method = RequestMethod.GET)
23     public AppointmentForm getNewForm() {
24         return new AppointmentForm();
25     }
26
27     @RequestMapping(method = RequestMethod.POST)
28     public String add(@Valid AppointmentForm appointment, BindingResult result) {
29         if (result.hasErrors()) {
30             return "appointments/new";
31         }
32         appointmentBook.addAppointment(appointment);
33         return "redirect:/appointments";
34     }
35 }

value的uri值为以下三类：

A） 可以指定为普通的具体值；

B)  可以指定为含有某变量的一类值(URI Template Patterns with Path Variables)；

C) 可以指定为含正则表达式的一类值( URI Template Patterns with Regular Expressions);

example B)

@RequestMapping(value="/owners/{ownerId}", method=RequestMethod.GET)
public String findOwner(@PathVariable String ownerId, Model model) {
  Owner owner = ownerService.findOwner(ownerId);
  model.addAttribute("owner", owner);
  return "displayOwner";
}

example C)

@RequestMapping("/spring-web/{symbolicName:[a-z-]+}-{version:\d\.\d\.\d}.{extension:\.[a-z]}")
  public void handle(@PathVariable String version, @PathVariable String extension) {
    // ...  }

}

2.method:指定请求的method类型（GET、POST、PUT、DELETE等）;

<2>consumes、produces:

1.cousumes的样例：

   @Controller
        @RequestMapping(value = "/pets", method = RequestMethod.POST, consumes="application/json")
         public void addPet(@RequestBody Pet pet, Model model) {
                   // implementation omitted
          }

方法仅处理request Content-Type为“application/json”类型的请求。

2.produces的样例：

@Controller
@RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, produces="application/json")
@ResponseBody
public Pet getPet(@PathVariable String petId, Model model) {
    // implementation omitted
}

方法仅处理request请求中Accept头中包含了"application/json"的请求，同时暗示了返回的内容类型为application/json;

<3>params、headers

1.params的样例：

@Controller
@RequestMapping("/owners/{ownerId}")
public class RelativePathUriTemplateController {

  @RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, params="myParam=myValue")
  public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {
    // implementation omitted  }
}

仅处理请求中包含了名为“myParam”，值为“myValue”的请求；

2. headers的样例：

@Controller
@RequestMapping("/owners/{ownerId}")
public class RelativePathUriTemplateController {

@RequestMapping(value = "/pets", method = RequestMethod.GET, headers="Referer=http://www.ifeng.com/")
  public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {
    // implementation omitted  }
}

仅处理request的header中包含了指定“Refer”请求头和对应值为“http://www.ifeng.com/”的请求；

<4> @RequestMapping拦截多个请求

1 @RequestMapping(value={"dayAttendanceCount","psdayAttendanceCount"})

@RequestBody

<1>作用：

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

<2>使用时机：

  1. GET、POST方式提交时，根据request header ContentType的值来判断：
  • application/x-www-form-urlencoded， 可选（即非必须，因为这种情况的数据@RequestParam, @ModelAttribute也可以处理，当然@RequestBody也能处理）；
  • multipart/form-data, 不能处理（即使用@RequestBody不能处理这种格式的数据）；
  • 其他格式， 必须（其他格式包括application/json, application/xml等。这些格式的数据，必须使用@RequestBody来处理）；

　2.PUT方式提交时，根据request header Content-Type的值来判断:

  • application/x-www-form-urlencoded， 必须；
  • multipart/form-data, 不能处理；
  • 其他格式， 必须；

说明：request的body部分的数据编码格式由header部分的Content-Type指定；

@ResponseBody

<1> 作用：

该注解用于将Controller的方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区。

<2> 使用时机：

返回的数据不是html标签的页面，而是其他某种格式的数据时（如json、xml等）使用；

@PathVariable

当使用@RequestMapping URI template 样式映射时， 即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。

示例代码：[java]

@Controller
@RequestMapping("/owners/{ownerId}")
public class RelativePathUriTemplateController {  

  @RequestMapping("/pets/{petId}")
  public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {
    // implementation omitted
  }
}

上面代码把URI template 中变量 ownerId的值和petId的值，绑定到方法的参数上。若方法参数名称和需要绑定的uri template中变量名称不一致，需要在@PathVariable("name")指定uri template中的名称。

@RequestParameter

A） 常用来处理简单类型的绑定，通过Request.getParameter() 获取的String可直接转换为简单类型的情况（ String--> 简单类型的转换操作由ConversionService配置的转换器来完成）；因为使用request.getParameter()方式获取参数，所以可以处理get 方式中queryString的值，也可以处理post方式中 body data的值；

B）用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容，提交方式GET、POST；

C) 该注解有两个属性： value、required； value用来指定要传入值的id名称，required用来指示参数是否必须绑定；

示例代码：

@Controller
@RequestMapping("/pets")
@SessionAttributes("pet")
public class EditPetForm {
    @RequestMapping(method = RequestMethod.GET)
 public String setupForm(@RequestParam("petId") int petId, ModelMap model) {
       Pet pet = this.clinic.loadPet(petId);
   model.addAttribute("pet", pet);
   return "petForm";
   }

@Autowired

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

@Scope

当我们在一个ACTION类里面写很多个方法的时候（其实是一种按功能划分模块编程的思想），每个方法的返回状态可能不一样，如果ACTION中不@Scope("prototype")，有可能报找不到XXXACTION的错误！写上这个就表示每次请求都重新创建一个ACTION，与SINGALON对应，俗称“多例”。

 

@Component 和 @Controller,@Service,@Repository

1、@controller 控制器（注入服务）

2、@service 服务（注入dao）
3、@repository dao（实现dao访问）
4、@component （把普通pojo实例化到spring容器中，相当于配置文件中的<bean id="" class=""/>）

@Component,@Service,@Controller,@Repository注解的类，并把这些类纳入进spring容器中管理。 
下面写这个是引入component的扫描组件

<context:component-scan base-package=”com.mmnc”>

在一个稍大的项目中，通常会有上百个组件，如果这些组件采用xml的bean定义来配置，显然会增加配置文件的体积，查找以及维护起来也不太方便。 Spring2.5为我们引入了组件自动扫描机制，他可以在类路径底下寻找标注了@Component,@Service,@Controller,@Repository注解的类，并把这些类纳入进spring容器中管理。它的作用和在xml文件中使用bean节点配置组件时一样的。要使用自动扫描机制，我们需要打开以下配置信息：

Java代码： 

 <?xml version="1.0" encoding="UTF-8" ?> <beansxmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:context="http://www.springframework.org/schema/context"xsi:schemaLocation="http://www.springframework.org/schema/beans  http://www.springframework.org/schema/beans/spring-beans-2.5.xsd  http://www.springframework.org/schema/context  http://www.springframework.org/schema/context/spring-context-2.5.xsd"
 > <context:component-scan base-package=”com.eric.spring”>
 </beans>

其中base-package为需要扫描的包（含所有子包） @Service用于标注业务层组件，@Controller用于标注控制层组件（如struts中的action）,@Repository用于标注数据访问组件，即DAO组件，而@Component泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

@Service
public class VentorServiceImpl implements iVentorService{
 } @Repository public class VentorDaoImpl implements iVentorDao {
 } getBean的默认名称是类名（头字母小写），如果想自定义，可以@Service(“aaaaa”)这样来指定，这种bean默认是单例的，如果想改变，可以使用@Service(“beanName”)@Scope(“prototype”)来改变。可以使用以下方式指定初始化方法和销毁方法（方法名任意）： @PostConstructpublic void init() {
 }
@PreDestroy public void destory() {
}

@RequiresPermission

例如： @RequiresPermissions({"file:read", "write:aFile.txt"} )

  void someMethod();

要求subject中必须同时含有file:read和write:aFile.txt的权限才能执行方法someMethod()。否则抛出异常AuthorizationException。

时间： 2024-10-10 01:17:14

框架中常见的注解分析的相关文章

玩转SSH之Spring(一)---关于Srping框架中使用@query注解实现复杂查询

在Spring框架中,关于从数据表获取数据有不同的方法,当数据查询比较简单时,可以通过继承JpaRepository<T, L> 使用findBy***方法,通过分析方法名来实现查询,T表示要查询的数据表所对应的实体,L表示该实体主键的类型,比如Long.关于findBy方法如何通过分析方法名来实现查询,网上资料很多,不做赘述. 如果查询的数据比较复杂,查询条件比较复杂时,可以考虑使用JPA的@query方法来实现查询.关于使用方法,下面做简单介绍: 1.首先Dao层需继承Repository

Java异常打印输出中常见方法的分析

Java异常是在Java应用中的警报器,在出现异常的情况下,可以帮助我们程序猿们快速定位问题的类型以及位置.但是一般在我们的项目中,由于经验阅历等多方面的原因,依然有若干的童鞋在代码中没有正确的使用异常打印方法,导致在项目的后台日志中,没有收到日志或者日志信息不完整等情况的发生,这些都给项目埋下了若干隐患.本文将深入分析在异常日志打印过程中的若干情况,并给出若干的使用建议. 1. Java异常Exception的结构分析 我们通常所说的Exception主要是继承于Throwable而来,可以参

Java中常见的注解

1.JDK自带的注解@Override  @Deprecated  @Suppvisewarnings 常见第三方注解 Spring:@Autowired  @Service  @Repository Mybatis:@InsertProvider  @UpdateProvider  @Options 注解的分类: 依照执行机制分: 源代码注解:注解仅仅在源代码中存在,编译成.class文件就不存在了; 编译时注解:注解在源代码和.class文件里都存在(JDK自带的三个注解(@Override

SSM框架中常用的注解

@Controller:在SpringMVC 中,控制器Controller 负责处理由DispatcherServlet 分发的请求,它把用户请求的数据经过业务处理层处理之后封装成一个Model ,然后再把该Model 返回给对应的View 进行展示.在SpringMVC 中提供了一个非常简便的定义Controller 的方法,你无需继承特定的类或实现特定的接口,只需使用@Controller 标记一个类是Controller ,然后使用@RequestMapping 和@RequestPar

二、数字电路中常见器件应用分析-三极管

 一. 三极管简介  种类 根据构成三极管中的三块半导体类型的不同,有NPN型和PNP型两种:根据材料的不同有硅管和锗管两种,常见的硅管,Vbe间的压降是0.7V,锗管则是0.2V. 作用   三极管有三种状态,放大.截止和饱和,是一种控制电流的半导体器件.利用不同的状态特性,三极管的主要作用有两个: 1.将微弱信号放大成幅值较大的电信号 2.用作无触点开关-即开关特性.  二. 三极管用作开关  开关条件 不管是NPN型还是PNP型三极管,三极管的导通条件是:箭头朝内PNP,箭尾的电压高于箭头

linux系统中常见的性能分析工具

一.vmstat vmstat是linux/unix上一个监控工具,能展示给定时间间隔的服务器的状态,包括操作系统的内存信息,CPU使用状态.进程信息等. 语法: vmstat [-V] [delay [count]]     #-V     打印出vmstat工具的版本信息     #delay  设置两次输出的时间间隔     #count  设置总共输出的次数 对输出参数进行讲解 procs r:运行进程数(即真正分配到cpu的进程数量),如果该值长期大于系统逻辑cpu的数量,表示cpu不

SQL中常见sqlCode原因分析

000 | 00000 | SQL语句成功完成 01xxx | SQL语句成功完成,但是有警告 +012 | 01545 | 未限定的列名被解释为一个有相互关系的引用 +098 | 01568 | 动态SQL语句用分号结束 +100 | 02000 | 没有找到满足SQL语句的行 +110 | 01561 | 用DATA CAPTURE定义的表的更新操作不能发送到原来的子系统 +111 | 01590 | 为2型索引设置了SUBPAGES语句 +117 | 01525 | 要插入的值的个数不等于

Spring框架中的@Import注解

@Import注解的作用和在使用spring的xml配置时用到的<import/>类似.但应注意是@Import在使用时必须要保证能被IOC容器扫描到,所以通常它会和@Configuration或者@ComponentScan配套使用. @Import可以用来如下四种方式的导入: 带有@Configuration注解的类 实现了ImportSelector接口的类 实现了ImportBeanDefinitionRegistrar接口的类 被IOC容器注册的bean的class @Import在

微擎框架中receive.php代码分析

原文地址:https://www.cnblogs.com/guiyishanren/p/11025125.html