详解Spring Boot中Controller用法

controller

controller是springboot里最基本的组件，他的作用是把用户提交来的请求通过对url的匹配，分配个不同的接收器，再进行处理，然后向用户返回结果。他的重点就在于如何从http请求中获得信息，提取参数，并分发给不同的处理服务。

基本组成

一个最经典的controller应该大概长这样:

package com.example.demo.controller;
import org.springframework.stereotype.controller;
import org.springframework.web.bind.annotation.requestmapping;
/**
 * created by myths on 5/16/17.
 */
@controller
public class indexcontroller {
  @requestmapping(value = {"index", "/"})
  public string index(model model) {
    return "index";
  }
}

首先应该在类的开头，加上@controller注解，告知spring这是一个控制器。

然后在对应的处理函数前面加上@requestmapping，告知这个函数需要相应的url。

接着这个函数传入了一个model类型的参数，这个参数主要是用于向模板传递数据。

该函数最后返回了一个叫”index”的字符串，表示将调用名为”index”的模板，具体名称取决于模板引擎，比如对于jsp他将访问”index.jsp”这个文件,对于thymeleaf，他将访问”index.html”这个文件。

上面的是最简单的用法，实际上有很多细节需要注意，下面就来一一解释。

responsebody

如果我们想返回纯字符串而不是渲染后的模板，那我们可以在需要返回字符串的函数前面加上@responsebody这个注解；
如果我们像对于整个类都返回字符串，我们也可以在这个类前面加上@responsebody注解，或者将@controller注解换成@restcontroller，均可。

requestmapping

基本用法

这个注解是用来告诉spring，下面的这个函数或者类是用来映射到那个url的，通常情况下有下面这些选项：

@requestmapping(
    path = {"/test"},
    params = {"name","userid"},
    method = {requestmethod.get},
    consumes = {"text/plain", "application/*"},
    produces = "text/plain",
    headers = "content-type=text/*"
)

我们可以指定这个路径，参数，方法，头信息，来作为一个controller的入口。当然，通常我们只需要指定path就行了。

作用对象

这个注解可以注解一个函数，也可以注解一个类。当注解一个类时，类中所有的方法都会在这个基础上再进行过滤：

@controller
@requestmapping("/path1")
public class testcontroller {
  @requestmapping("/path2")
  @responsebody
  public string index() {
    return "ok";
  }
}

这个函数就能匹配”/path1/path1”这个地址。

缺省参数

当requestmapping的参数是空的时候，他就表示匹配剩余所有的页面,实际上也就是匹配所有的404页面。

@controller
public class indexcontroller {
  @requestmapping
  public string index(model model) {
    return "index";
  }
}

当requestmapping不指定参数名时，默认就是path参数。

@controller
public class indexcontroller {
  @requestmapping("/index")
  public string index(model model) {
    return "index";
  }
}

pathvariable

requestmapping中的path也可以是一个未定的变量，比如下面的代码:

@controller
public class testcontroller {
  @requestmapping("/{variable}")
  @responsebody
  public string index(@pathvariable("variable")string variable) {
    return variable;
  }
}

通过花括号我们就可以指定这个变量，并且通过@pathvariable注解得到这个参数，非常方便。

requestparam

requestmapping也可以获取类似表单传回的信息形式，比如/index?name=xxx，这个name变量就可以通过requestparam注解来获得:

@controller
public class testcontroller {
  @requestmapping("/index")
  @responsebody
  public string index(@requestparam(value = "name",required = false,defaultvalue = "233")string name) {
    return name;
  }
}

我们可以控制这个参数的名字，是否必须，以及设置默认值，来更好的进行匹配。

requestbody

requestbody用来获取post信息的消息体,只要在参数中通过@requestbody注解就能得到这个参数:

@controller
public class testcontroller {
  @requestmapping("/index")
  @responsebody
  public string index(@requestbody string body) {
 //对body进行解析即可
    return "success";
  }
}

总结

上面这些大概就是controller中最基本的用法了，十分的方便清楚。具体的细节可以参考源码中的注释，解释的也是十分详尽了。

以上所述是小编给大家介绍的spring boot中controller用法，希望对大家有所帮助