SpringMVC注解（一）

   在SpringMVC中，控制器Controller负责处理由DispatcherServlet分发的请求，它把用户请求的数据经过业务处理层处理之后封装成一个Model，然后再把该Model返回给对应的View进行展示。在SpringMVC中提供了一个非常简便的定义Controller的方法，你无需继承特定的类或实现特定的接口，只需使用@Controller标记一个类是Controller，然后使用@RequestMapping和@RequestParam等一些注解用以定义URL请求和Controller方法之间的映射，这样的Controller就能被外界访问到。此外Controller不会直接依赖于HttpServletRequest和HttpServletResponse等HttpServlet对象，它们可以通过Controller的方法参数灵活的获取到。

 

一、@Controller注解： 用于标记在一个类上，使用它标记的类就是一个SpringMVC Controller对象。分发处理器将会扫描使用了该注解的类的方法，并检测该方法是否使用了@RequestMapping注解。

  @Controller 只是定义了一个控制器类，而使用@RequestMapping注解的方法才是真正处理请求的处理器。单单使用@Controller 标记在一个类上还不能真正意义上的说它就是SpringMVC的一个控制器类，因为这个时候SpringMVC还不认识它。那么要如何做Spring才能认识它呢？这个时候就需要我们把这个控制器类交给SpringMVC来管理。有两种方式：

　　（1）在SpringMVC的配置文件中定义MyController的bean对象。

　　（2）在SpringMVC的配置文件中告诉SpringMVC该到哪里去找标记为@Controller的Controller控制器。

<!--方式一-->

   <bean class="com.host.app.web.controller.MyController"/>

<!--方式二-->

   <context:component-scan base-package = "com.host.app.web" />

 

二、@RequestMapping注解： 是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。

   @RequestMapping注解有六个属性， 下面我们把她分成三类进行说明：

 

   1、value、method：

 

    value： 指定请求的实际地址，指定的地址可以是URI Template 模式（后面将会说明）；

    method：指定请求的method类型， GET、POST、PUT、DELETE等；

  2、consumes、produces

    consumes： 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;

    produces: 指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回;

    @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

    params： 指定request中必须包含某些参数值是，才让该方法处理。

    headers： 指定request中必须包含某些指定的header值，才能让该方法处理请求。

示例：SpringMVC获取页面表单参数的几种方式

  第一种方式：直接把表单的参数写在Controller相应的方法的形参中 （控制器中方法的形参String userName，String userPwd名称必须和登陆页面的name="userName"，name="userPwd"相同） 

 首先写一个登录页面和beane类：

   <form action="temp.do" method="post">

      UserName:

      <input type="text" name="userName"/>

      <br><br>

      PassWord:

      <input type="password" name="userPwd"/>

      <br><br>

      <input type="submit" value="Login"/>

    </form>

  public class User implements Serializable {

    private static final long serialVersionUID = 1L;

    private String userName;

    private String userPwd;

    public String getUserName() {

       return userName;

    }

    public void setUserName(String userName) {

       this.userName = userName;

    }

    public String getUserPwd() {

       return userPwd;

    }

    public void setUserPwd(String userPwd) {

       this.userPwd = userPwd;

    }

}

@Controller

public class UserController {

   @RequestMapping("/temp.do")

    public String loginByUser(String userName, String userPwd) {

          System.out.println("userName is:" + userName);

          System.out.println("userPwd is:" + userPwd);

       return "success";

   }

}

 

第二种方式： 通过HttpServletRequest接收（参数名称必须和登陆页面的name="userName"，name="userPwd"相同）

  @Controller 

  public class UserController {

      @RequestMapping("/temp.do")

      public String loginByUser(HttpServletRequest request) {

            String userName=request.getParameter("userName");

            String userPwd=request.getParameter("userPwd");

            System.out.println("userName is:" + userName);

            System.out.println("userPwd is:" + userPwd);

           return "success";

      }

   }

 

第三种方式： 通过一个bean来接收(登陆页面的name="userName"，name="userPwd"必须和Bean类的属性名称相同)

@Controller

public class UserController {

    @RequestMapping("/temp.do")

    public String loginByUser(User user) {

       System.out.println("userName is:" + user.getUserName());

       System.out.println("userPwd is:" + user.getUserPwd());

       return "success";

     }

  }

 

第四种方式： 通过json数据接收( var user={userName:name,userPwd:pwd};//拼装成json格式 语句中userName,userPwd必须和Bean类中属性名称相同)

<script type="text/javascript">

  $(function() {

    $("#button_submit").click(function() {

       var name = $("#userName").val();

       var pwd = $("#userPwd").val();

       var user = {

          userName : name,

          userPwd : pwd

       };//拼装成json格式 

 $.ajax({

    type : "POST",

    url : "/temp.do",

    data : user,

    success : function(data) {

         console.info("成功");

       },

    error : function(e) {

        console.info("出错：" + e);

    }

      });

    });

 });

</script>

 

@Controller

public class UserController {

   @RequestMapping("/temp.do")

   public String loginByUser(User user) {

     System.out.println("userName is:" + user.getUserName());

     System.out.println("userPwd is:" + user.getUserPwd());

     return "success";

   }

 }

 

三、@ResponseBody注解: 作用是将Controller方法返回的对象通过适当的转换器（HttpMessageConverter）转换为指定的格式，并将其写入到response对象的body区，一般都是用来返回JSON数据或者XML数据。在使用此注解后，SpringMVC将不会再走视图处理器，而是直接将数据写入到流中，它的效果等同于通过response对象输出指定格式的数据。

 

示例：

   1、导入Jackson包：

    <dependency>

    <groupId>com.fasterxml.jackson.core</groupId>

    <artifactId>jackson-databind</artifactId>

    <version>2.9.5</version>

  </dependency>

  <dependency>

    <groupId>com.fasterxml.jackson.core</groupId>

    <artifactId>jackson-core</artifactId>

    <version>2.9.5</version>

  </dependency>

      

  2、定义JavaBean：

       public class User implements Serializable{

    

         private static final long serialVersionUID = 1L;

         private Integer id;

         private String name;

       

         @JsonFormat(pattern = "yyyy年MM月dd日")

         private Date birthday; //格式化日期属性

         

         private String email;

   

         public User() {

           super();

         }    

         public User(Integer id, String name, Date birthday, String email) {

            this.id = id;

            this.name = name;

            this.birthday = birthday;

            this.email = email;

         } 

             //省略set/get方法

  }

  3、定义Controller：

       @Controller

    public class UserController {

       @RequestMapping(value="/info",method=RequestMethod.POST,produces="text/html;charset=utf-8")

       @ResponseBody

       public String getInfo(User user,Model model) throws ParseException, JsonProcessingException

        {

          SimpleDateFormat dateformat = new SimpleDateFormat("yyyy-MM-dd");

          

          List<User> list = new ArrayList<User>();

          

          User u1 = new User(1001,"小明",dateformat.parse("1990-10-10"),"xiaoming@qq.com");

          User u2 = new User(1002,"小强",dateformat.parse("1989-12-10"),"xiaoqiang@qq.com");

          User u3 = new User(1003,"小刚",dateformat.parse("1991-11-19"),"xiaogang@qq.com");

          User u4 = new User(1004,"小米",dateformat.parse("1995-10-10"),"xiaomi@qq.com");

          User u5 = new User(1005,"小乔",dateformat.parse("1992-10-10"),"xiaoming@qq.com");

          

          list.add(u1);

          list.add(u2);

          list.add(u3);

          list.add(u4);

          list.add(u5);

          

          ObjectMapper objectMapper = new ObjectMapper();

          String jsonMapper = objectMapper.writeValueAsString(list);

          

          return jsonMapper;

       }

    }

   

  4、配置springmvc.xml文件：

       <mvc:annotation-driven/>

       <context:component-scan base-package="com.cn.controller"/>

      <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">

        <property name="prefix" value="/WEB-INF/views/"></property>

        <property name="suffix" value=".jsp"></property>

      </bean>

   

  5、前端页面：

      <link type="text/css" rel="stylesheet" href="js/jquery-easyui-1.5.2/themes/default/easyui.css"/>

    <link type="text/css" rel="stylesheet" href="js/jquery-easyui-1.5.2/themes/icon.css"/>

    <script type="text/javascript" src="js/jquery-easyui-1.5.2/jquery.min.js"></script>

    <script type="text/javascript" src="js/jquery-easyui-1.5.2/jquery.easyui.min.js"></script>

    <script type="text/javascript" src="js/jquery-easyui-1.5.2/locale/easyui-lang-zh_CN.js"></script>

<script type="text/javascript">

 $(function(){

      $('#dg').datagrid({   

              url:'info.do',

              method:'post',

              columns:[[   

                  {field:'id',title:'编号',width:100},   

                  {field:'name',title:'姓名',width:100},   

                  {field:'birthday',title:'生日',width:200,align:'right'},

                  {field:'email',title:'邮箱',width:200}

              ]]   

          }); 

      });

</script>

<body>

  <table id="dg"></table>

</body>

    假如是字符串则直接将字符串写到客户端,假如是一个对象，此时会将对象转化为json串然后写到客户端。这里需要注意的是，如果返回对象,按utf-8编码。如果返回String，默认按iso8859-1编码，页面可能出现乱码。因此在注解中我们可以手动修改编码格式，例如@RequestMapping(value="/login",produces="text/html;charset=utf-8")，前面是请求的路径，后面是编码格式。

    控制层方法的返回值是如何转化为json格式的字符串的呢？其实是通过HttpMessageConverter中的方法实现的，因为它是一个接口，因此由其实现类完成转换。如果是bean对象，会调用对象的getXXX（）方法获取属性值并且以键值对的形式进行封装，进而转化为json串。如果是map集合，采用get(key)方式获取value值，然后进行封装。