从Spring MVC 3 Controller仅返回字符串消息


93

谁能告诉我如何从控制器返回字符串消息?

如果我只是从控制器方法返回一个字符串,那么spring mvc会将其视为jsp视图名称。

Answers:


191

使用@ResponseBody以下命令在控制器中注释方法:

@RequestMapping(value="/controller", method=GET)
@ResponseBody
public String foo() {
    return "Response!";
}

来自:15.3.2.6将响应主体与@ResponseBody注释映射

可以将@ResponseBody注释放在方法上,并指出返回类型应直接写到HTTP响应主体(而不是放置在模型中,或解释为视图名称)。


27
为了清楚 @RequestMapping(value="/controller", method=GET, produces="text/plain")
起见

真正的答案总是在评论中。
约翰内斯·斯塔德勒

48

在Spring 4中,如果您的Controller用@RestController代替@Controller,则您不需要@ResponseBody注释。

该代码将是

@RestController
public class FooController {

   @RequestMapping(value="/controller", method=GET)
   public String foo() {
      return "Response!";
   }

}

您可以在这里找到Javadoc@RestController


谢谢,这帮助我弄清楚我需要使用\ @Controller而不是\ @RestController来返回视图而不是String。
khriskooper

@khriskooper很高兴听到它:)
geoand

18

尽管@Tomasz绝对正确,但还有另一种方法:

@RequestMapping(value="/controller", method=GET)
public void foo(HttpServletResponse res) {
    try {       
        PrintWriter out = res.getWriter();
        out.println("Hello, world!");
        out.close();
    } catch (IOException ex) { 
        ...
    }
}

但是第一种方法是可取的。如果要返回具有自定义内容类型的响应或返回二进制类型(文件等),则可以使用此方法。


只是一个提示,但是您甚至不需要为此做出回应。
斯科特,

这意味着第二点,关于需要设置自定义内容类型或返回二进制类型,您仍然可以将ResponseEntity用于这些方法。
斯科特

6

对于那些以后可能会发现此问题的人来说,这只是一个注释,但您不必拉回响应即可更改内容类型。下面是一个执行此操作的示例:

@RequestMapping(method = RequestMethod.GET, value="/controller")
public ResponseEntity<byte[]> displayUploadedFile()
{
  HttpHeaders headers = new HttpHeaders();
  String disposition = INLINE;
  String fileName = "";
  headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);

  //Load your attachment here

  if (Arrays.equals(Constants.HEADER_BYTES_PDF, contentBytes)) {
    headers.setContentType(MediaType.valueOf("application/pdf"));
    fileName += ".pdf";
  }

  if (Arrays.equals(Constants.HEADER_BYTES_TIFF_BIG_ENDIAN, contentBytes)
      || Arrays.equals(Constantsr.HEADER_BYTES_TIFF_LITTLE_ENDIAN, contentBytes)) {
    headers.setContentType(MediaType.valueOf("image/tiff"));
    fileName += ".tif";
  }

  if (Arrays.equals(Constants.HEADER_BYTES_JPEG, contentBytes)) {
    headers.setContentType(MediaType.IMAGE_JPEG);
    fileName += ".jpg";
  }

  //Handle other types if necessary

  headers.add("Content-Disposition", , disposition + ";filename=" + fileName);
  return new ResponseEntity<byte[]>(uploadedBytes, headers, HttpStatus.OK);
}

3

关于什么:

PrintWriter out = response.getWriter();
out.println("THE_STRING_TO_SEND_AS_RESPONSE");
return null;

这让我大吃一惊。


3

对于outputing Stringtext/plain使用:

@RequestMapping(value="/foo", method=RequestMethod.GET, produces="text/plain")
@ResponseBody
public String foo() {
    return "bar";
}

1
这对我不起作用。在返回String对象之前,我必须获取响应对象并明确设置内容类型。
佩德罗马德里
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.