RequestParam

没有阅读Controller、RestController和RequestMapping章节的开发者应先阅读上述几个章节。

作用

只能用在方法参数上，用来获取客户端的请求参数。

RequestParam支持注解的参数类型有：MultipartFile、String、int、long、float、double、boolean，其中MultipartFile表示表单中的文件，其它类型可以是 Url 中的参数、Body 中的参数（客户端Content-Type是application/x-www-form-urlencoded，数据又在 Body 中时）、表单中的参数。

如果要单独获取 Url 中的参数请使用QueryParam注解。

接受普通参数示例

@RestController
public class UserController {

    @PostMapping("/user/login")
    void login(@RequestParam("account") String account,
        @RequestParam("password") String password) {
        ...
    }
}

上述示例是一个模拟用户登录的 HTTP API，客户端必须提交account和parssword参数，否则将会抛出ParamMissingException异常。

异常处理请参考ExceptionResolver。

我们也可以让某参数不是必填的，同时也可以选择给它一个默认值：

@RestController
public class UserController {

    @GetMapping("/user/info")
    void info(@RequestParam(name = "id",  required = false, defaultValue = "123")
        long id) {
        ...
    }
}

上述示例中，如果客户端请求中没有提交id参数或者id参数为空，那么开发者接受到的值则是123。

接受文件示例

@RestController
public class UserController {

    @PostMapping("/user/upload")
    String upload(@RequestParam("image") MultipartFile file) throws IOException {
        File localFile = ...; // Create a file at the target location.
        file.transferTo(localFile); // Transfer the file to the target location.
        return localFile.getAbsolutePath();
    }
}

入参MultipartFile是一个临时文件，它保存在WebConfig这里配置的上传文件保存目录，你也可以把这个文件转移到任何位置保存。

强烈建议不要转移，在 WebConfig 配置好就好了，转移的话要耗费文件拷贝时间，这样降低了接口性能。

无需注解的参数

一些特殊参数不需要注解就可以拿到，支持不用注解的参数有Context、HttpRequest、HttpResponse、Session、RequestBody。

上述Context是 Android 中的android.content.Context。

@Controller
public class ProjectController {

    @GetMapping("/project/get")
    public String get() {
        ...
    }

    @GetMapping("/project/info")
    public void info(HttpRequest request, HttpResponse response) {
        ...
    }

    @GetMapping("/project/context")
    public Project get(Context context, @RequestParam("name") String name) {
        ...
    }

    @GetMapping("/project/body")
    public void body(RequestBody body, HttpResponse response) {
        ...
    }
}

方法的返回值可以有，也可以没有。

相关阅读推荐：

• QueryParam
• FormPart