cn.ipokerface.web.controller

类 BaseController

java.lang.Object

cn.ipokerface.common.logback.LoggerAdapter

cn.ipokerface.web.controller.BaseController

直接已知子类:

HandlerController

public abstract class BaseController
extends LoggerAdapter

Created by PokerFace Create Date 2019-11-23. Email: Version 1.0.0

Description: some api to operate request and response All controller should extend this BaseController

字段概要

从类继承的字段 cn.ipokerface.common.logback.LoggerAdapter

logger

构造器概要

构造器

构造器和说明
BaseController()

方法概要

限定符和类型	方法和说明
protected ResultBody	error()
protected ResultBody	error(int code, String message)
protected ResultBody	error(String message)
protected String	getClientIpAddress(javax.servlet.http.HttpServletRequest request) Get client real ip address .
protected ResultBody	success()
protected <T> ResultBody<T>	success(T model) success response
protected void	writeFile(javax.servlet.http.HttpServletResponse response, InputStream inputStream, String filename) Write file of inputStream to outputStream
protected void	writeFile(javax.servlet.http.HttpServletResponse response, String filePath) write file to response

从类继承的方法 cn.ipokerface.common.logback.LoggerAdapter

error

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

BaseController

public BaseController()

方法详细资料

getClientIpAddress

protected String getClientIpAddress(javax.servlet.http.HttpServletRequest request)

Get client real ip address . Header of client ip is Header.X_FORWARDED_FOR_HEADER and this header may rewrite by gateway service such as nignx

参数:

request - tomcat request

返回:

real ip address of client

writeFile

protected void writeFile(javax.servlet.http.HttpServletResponse response,
                         String filePath)
                  throws IOException

write file to response

参数:

response - httpResponse

filePath - file path of file

抛出:

IOException - exception io

writeFile

protected void writeFile(javax.servlet.http.HttpServletResponse response,
                         InputStream inputStream,
                         String filename)
                  throws IOException

Write file of inputStream to outputStream

参数:

response - httpResponse

inputStream - inputStream

filename - file name just name

抛出:

IOException - exception io

success

protected <T> ResultBody<T> success(T model)

success response

参数:

model - response body

返回:

response entity

success

protected ResultBody success()

error

protected ResultBody error()

error

protected ResultBody error(String message)

error

protected ResultBody error(int code,
                           String message)