org.voovan.http.server.HttpRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of voovan-framework Show documentation
Show all versions of voovan-framework Show documentation
Voovan is a java framwork and it not depends on any third-party framework.
package org.voovan.http.server;
import org.voovan.http.message.Request;
import org.voovan.http.message.packet.Cookie;
import org.voovan.http.message.packet.Part;
import org.voovan.http.server.context.WebContext;
import org.voovan.network.IoSession;
import org.voovan.tools.TString;
import org.voovan.tools.reflect.TReflect;
import java.io.File;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.text.ParseException;
import java.util.*;
/**
* WebServer 请求对象
* @author helyho
*
* Voovan Framework.
* WebSite: https://github.com/helyho/Voovan
* Licence: Apache v2 License
*/
public class HttpRequest extends Request {
private HttpSession session;
private String characterSet;
private Map parameters;
private Map attributes;
private IoSession socketSession;
private SessionManager sessionManager;
/**
* 构造函数
* @param request 解析出的 Request 对象
* @param characterSet 字符集
* @param socketSession socket 会话对象
*/
public HttpRequest(Request request, String characterSet, IoSession socketSession){
super(request);
this.characterSet=characterSet;
parameters = new LinkedHashMap();
attributes = new HashMap();
parseQueryString();
this.socketSession = socketSession;
}
/**
* 构造函数
* @param characterSet 字符集
* @param socketSession socket 会话对象
*/
public HttpRequest(String characterSet, IoSession socketSession){
this.characterSet=characterSet;
parameters = new LinkedHashMap();
attributes = new HashMap();
parseQueryString();
this.socketSession = socketSession;
}
public void init(Request request, String characterSet, IoSession socketSession){
super.init(request);
this.characterSet=characterSet;
parameters.clear();
attributes.clear();
parseQueryString();
this.socketSession = socketSession;
}
protected void setSessionManager(SessionManager sessionManager) {
this.sessionManager = sessionManager;
}
/**
* 获取 socket 会话对象
* @return socket 会话对象
*/
protected IoSession getSocketSession() {
return socketSession;
}
/**
* 设置 socket 会话对象
* @param socketSession socket 会话对象
*/
protected void setSocketSession(IoSession socketSession) {
this.socketSession = socketSession;
}
/**
* 根据 Cookie 名称取 Cookie
*
* @param name Cookie 名称
* @return Cookie
*/
public Cookie getCookie(String name){
for(Cookie cookie : this.cookies()){
if(cookie !=null && name !=null && name.equals(cookie.getName())){
return cookie;
}
}
return null;
}
/**
* 判断 session 是否存在
* @return true: session 存在, false: session 不存在
*/
public boolean sessionExists(){
return session!=null ? true : false;
}
/**
* 获取 Session
*
* @return HTTP-Session 对象
*/
public HttpSession getSession() {
if(session == null){
//获取请求的 Cookie中的session标识
Cookie sessionCookie = getCookie(WebContext.getSessionName());
if(sessionCookie!=null) {
session = sessionManager.getSession(sessionCookie.getValue());
}
if(session == null){
session = sessionManager.newSession(this);
}
if(session!=null) {
session.init(sessionManager, getSocketSession());
// 请求关联 Session
setSession(session);
}
}
return session;
}
/**
* 设置一个 Session
*
* @param session HTTP-Session 对象
*/
protected void setSession(HttpSession session) {
this.session = session;
}
/**
* 获取对端连接的 IP
*
* @return 对端连接的 IP
*/
public String getRemoteAddres() {
String xForwardedFor = header().get("X-Forwarded-For");
String xRealIP = header().get("X-Real-IP");
if (xRealIP != null) {
return xRealIP;
} else if (xForwardedFor != null) {
return xForwardedFor.split(",")[0].trim();
}else{
return socketSession.remoteAddress();
}
}
/**
* 获取对端连接的端口
*
* @return 对端连接的端口
*/
public int getRemotePort() {
return socketSession.remotePort();
}
/**
* 获取当前默认字符集
*
* @return 字符集
*/
public String getCharacterSet() {
return characterSet;
}
/**
* 设置当前默认字符集
*
* @param charset 字符集
*/
protected void setCharacterSet(String charset) {
this.characterSet = charset;
}
/**
* 获取请求字符串
*
* @return 请求字符串
*/
protected String getQueryString(){
return getQueryString(characterSet);
}
/**
* 获取请求参数集合
*
* @return 请求参数集合
*/
public Map getParameters() {
return parameters;
}
/**
* 获取请求参数
*
* @param paramName 请求参数名称
* @return 请求参数值
*/
public String getParameter(String paramName){
return parameters.get(paramName);
}
/**
* 获取 int 类型的数据
* @param paramName 请求参数名称
* @return int 类型的数据
*/
public int getParameterAsInt(String paramName){
try {
return (int) TString.toObject(parameters.get(paramName), int.class);
}catch(Exception e){
throw new RuntimeException("Get parameter ["+paramName+"] as int error.",e);
}
}
/**
* 获取 float 类型的数据
* @param paramName 请求参数名称
* @return float 类型的数据
*/
public float getParameterAsFloat(String paramName){
try {
return (float) TString.toObject(parameters.get(paramName), float.class);
}catch(Exception e){
throw new RuntimeException("Get parameter ["+paramName+"] as float error.",e);
}
}
/**
* 获取 long 类型的数据
* @param paramName 请求参数名称
* @return long 类型的数据
*/
public long getParameterAsLong(String paramName){
try {
return (long) TString.toObject(parameters.get(paramName), long.class);
}catch(Exception e){
throw new RuntimeException("Get parameter ["+paramName+"] as long error.",e);
}
}
/**
* 获取 short 类型的数据
* @param paramName 请求参数名称
* @return short 类型的数据
*/
public short getParameterAsShort(String paramName){
try {
return (short) TString.toObject(parameters.get(paramName), short.class);
}catch(Exception e){
throw new RuntimeException("Get parameter ["+paramName+"] as short error.",e);
}
}
/**
* 获取 double 类型的数据
* @param paramName 请求参数名称
* @return double 类型的数据
*/
public double getParameterAsDouble(String paramName){
try {
return (double) TString.toObject(parameters.get(paramName), double.class);
}catch(Exception e){
throw new RuntimeException("Get parameter ["+paramName+"] as double error.",e);
}
}
/**
* 获取 boolean 类型的数据
* @param paramName 请求参数名称
* @return boolean 类型的数据
*/
public boolean getParameterAsBoolean(String paramName){
try {
return (boolean) TString.toObject(parameters.get(paramName), boolean.class);
}catch(Exception e){
throw new RuntimeException("Get parameter ["+paramName+"] as boolean error.",e);
}
}
/**
* 获取 byte 类型的数据
* @param paramName 请求参数名称
* @return byte 类型的数据
*/
public byte getParameterAsByte(String paramName){
try {
return (byte) TString.toObject(parameters.get(paramName), byte.class);
}catch(Exception e){
throw new RuntimeException("Get parameter ["+paramName+"] as byte error.",e);
}
}
/**
* 获取 char 类型的数据
* @param paramName 请求参数名称
* @return char 类型的数据
*/
public char getParameterAsChar(String paramName){
try {
return (char) TString.toObject(parameters.get(paramName), char.class);
}catch(Exception e){
throw new RuntimeException("Get parameter ["+paramName+"] as char error.",e);
}
}
/**
* 将 HTTP 请求的一个参数,使用 JSON 转换成一个 Java 对象
* @param paramName 参数名
* @param clazz 自定义数据类型
* @param 范型
* @return char 自定义数据类型的对象,转换时字段忽略大小写
*/
public T getParameterAsObject(String paramName, Class clazz){
try {
return TString.toObject(parameters.get(paramName), clazz);
} catch (Exception e) {
throw new RuntimeException("Conver parameters to "+clazz.getCanonicalName()+" error.",e);
}
}
/**
* 将 HTTP 请求的所有参数, 转换成一个 Java 对象
* @param clazz 自定义数据类型
* @param 范型
* @return char 自定义数据类型的对象,转换时字段忽略大小写
*/
@SuppressWarnings("unchecked")
public T getAllParameterAsObject(Class clazz){
try {
return (T) TReflect.getObjectFromMap(clazz, (Map)getParameters(), true);
} catch (ReflectiveOperationException | ParseException e) {
throw new RuntimeException("Conver parameters to "+clazz.getCanonicalName()+" error.",e);
}
}
/**
* 获取请求参数名称集合
*
* @return 请求参数集合
*/
public List getParameterNames(){
return Arrays.asList(parameters.keySet().toArray(new String[]{}));
}
/**
* 获取请求属性.此属性是会话级的
* @return 返回请求属性
*/
public Map getAttributes() {
return attributes;
}
/**
* 获取请求属性值
* @param attrName 请求属性名称
* @return 请求属性值
*/
public Object getAttributes(String attrName){
return attributes.get(attrName);
}
/**
* 设置请求属性
* @param attrName 请求属性名称
* @param attrValue 请求属性值
*/
public void setAttributes(String attrName,Object attrValue){
attributes.put(attrName,attrValue);
}
/**
* 解析请求参数
*/
private void parseQueryString() {
if(getQueryString()!=null){
String[] parameterEquals = getQueryString().split("&");
for(String parameterEqual :parameterEquals){
int equalFlagPos = parameterEqual.indexOf("=");
if(equalFlagPos>0){
String name = parameterEqual.substring(0, equalFlagPos);
String value = parameterEqual.substring(equalFlagPos+1, parameterEqual.length());
parameters.put(name, value);
}else{
parameters.put(parameterEqual, null);
}
}
}
}
/**
* 发送响应
* @throws IOException IO 异常
*/
public void send() throws IOException {
super.send(socketSession);
}
/**
* 追加形式发送数据
* @param byteBuffer 发送的缓冲区
* @return 发送的字节数
* @throws IOException IOException IO 异常
*/
public int send(ByteBuffer byteBuffer) throws IOException {
if(!super.basicSend) {
send();
}
return socketSession.send(byteBuffer);
}
/**
* 将数据发送到 Socket 缓存
*/
public void flush(){
socketSession.flush();
}
/**
* 保存上传的文件
* @param name 提交的参数名
* @param file 目标文件名
* @throws IOException IO 异常
*/
public void saveUploadedFile(String name, File file) throws IOException {
for(Part part: this.parts()){
if(part.getName().equals(name)){
part.saveAsFile(file);
return;
}
}
throw new IOException("The uploadFile parameter which name is "+name+" not found.");
}
/**
* 保存上传的文件
* @param name 提交的参数名
* @param file 目标文件名
* @throws IOException IO 异常
*/
public void saveUploadedFile(String name, String file) throws IOException {
saveUploadedFile(name, new File(file));
}
/**
* 重置请求
* 用于在 HttpFilter 中重新定向,其他地方无用
* @param url 请求地址,"/"起始,可以包含"?"参数引导及参数.
*/
public void redirect(String url){
String[] parsedURL = url.split("\\?");
this.protocol().clear();
this.body().clear();
this.parts().clear();
if(parsedURL.length>0) {
this.protocol().setPath(parsedURL[0]);
}
if(parsedURL.length > 1) {
this.protocol().setQueryString(parsedURL[1]);
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy