Как добавить собственное сообщение после кода состояния HTTP

Вы можете указать причину в аннотации @ResponseStatus:

@ResponseStatus(value = HttpStatus.FORBIDDEN, reason = "You custom reason")

У вас может быть тело HTTP-ответа, содержащее сообщение, которое вы можете проанализировать с любой дополнительной информацией.

Сообщение о состоянии HTTP в коде состояния (в ответе) может быть любым, и оно не повлияет на клиентов. HTTP-клиенты обычно игнорируют текст сообщения.

Вот альтернатива. Создайте универсальное исключение, которое принимает код состояния и сообщение. Затем создайте обработчик исключений. Используйте обработчик исключений, чтобы извлечь информацию из исключения и вернуться к вызывающей стороне службы.

http://javaninja.net/2016/06/throwing-exceptions-messages-spring-mvc-controller/

public class ResourceException extends RuntimeException {

    private HttpStatus httpStatus = HttpStatus.INTERNAL_SERVER_ERROR;

    public HttpStatus getHttpStatus() {
        return httpStatus;
    }

    /**
     * Constructs a new runtime exception with the specified detail message.
     * The cause is not initialized, and may subsequently be initialized by a
     * call to {@link #initCause}.
     * @param message the detail message. The detail message is saved for later retrieval by the {@link #getMessage()}
     *                method.
     */
    public ResourceException(HttpStatus httpStatus, String message) {
        super(message);
        this.httpStatus = httpStatus;
    }
}

Затем используйте обработчик исключений, чтобы получить информацию и вернуть ее вызывающей стороне службы.

@ControllerAdvice
public class ExceptionHandlerAdvice { 

    @ExceptionHandler(ResourceException.class)
    public ResponseEntity handleException(ResourceException e) {
        // log exception 
        return ResponseEntity.status(e.getHttpStatus()).body(e.getMessage());
    }         
} 

Затем создайте исключение, когда вам нужно.

throw new ResourceException(HttpStatus.NOT_FOUND, "We were unable to find the specified resource.");

Вы не сказали этого в своем вопросе, но я предполагаю, что вы используете Tomcat. По умолчанию Tomcat отправляет только код состояния и не отправляет фразу причины. Фраза причины является необязательной частью спецификации HTTP, поэтому я бы не рекомендовал полагаться на ее отправку.

Если вы действительно хотите полагаться на настраиваемую фразу причины, а не использовать тело ответа, как рекомендовали другие ответы, вам придется либо настроить Tomcat для отправки фразы причины (что поддерживается только в Tomcat 8.5), либо переключиться на другую контейнер. Что касается встроенных контейнеров сервлетов, поддерживаемых Spring Boot, как Jetty, так и Undertow отправят фразу причины.

Вот небольшой пример, который настраивает Tomcat как для отправки фразы причины, так и для включения использования настраиваемых фраз:

package sample.tomcat;

import javax.servlet.http.HttpServletResponse;

import org.apache.coyote.AbstractProtocol;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer;
import org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@SpringBootApplication
public class SampleTomcatApplication {

    @Bean
    public EmbeddedServletContainerCustomizer tomcatCustomizer() {
        return (container) -> {
            if (container instanceof TomcatEmbeddedServletContainerFactory) {
                ((TomcatEmbeddedServletContainerFactory) container)
                        .addConnectorCustomizers((connector) -> {
                            ((AbstractProtocol<?>) connector.getProtocolHandler())
                                    .setSendReasonPhrase(true);
                        });
            }
        };
    }

    public static void main(String[] args) throws Exception {
        System.setProperty("org.apache.coyote.USE_CUSTOM_STATUS_MSG_IN_HEADER", "true");
        SpringApplication.run(SampleTomcatApplication.class, args);
    }

}

@Controller
class SampleController {

    @GetMapping("/")
    public void customReasonPhrase(HttpServletResponse response) throws Exception {
        response.setStatus(503, "Custom");
    }

}