com.wl4g.infra.common.web.CookieUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of infra-common Show documentation
A Infra Common.
The newest version!
/*
 * Copyright 2017 ~ 2025 the original author or authors. James Wong 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.wl4g.infra.common.web;

import static java.util.Objects.nonNull;

import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.net.URLEncoder;

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * Cookie utility
 * 
 * @author wangl.sir
 * @version v1.0 2019年1月14日
 * @since
 */
public class CookieUtils {

    /**
     * 设置 Cookie（生成时间为1天）
     * 
     * @param name
     *            名称
     * @param value
     *            值
     */
    public static void setCookie(HttpServletResponse response, String name, String value) {
        setCookie(response, name, value, 60 * 60 * 24);
    }

    /**
     * 设置 Cookie
     * 
     * @param name
     *            名称
     * @param value
     *            值
     * @param maxAge
     *            生存时间（单位秒）
     * @param uri
     *            路径
     */
    public static void setCookie(HttpServletResponse response, String name, String value, String path) {
        setCookie(response, name, value, path, 60 * 60 * 24);
    }

    /**
     * 设置 Cookie
     * 
     * @param name
     *            名称
     * @param value
     *            值
     * @param maxAge
     *            生存时间（单位秒）
     * @param uri
     *            路径
     */
    public static void setCookie(HttpServletResponse response, String name, String value, int maxAge) {
        setCookie(response, name, value, "/", maxAge);
    }

    /**
     * 设置 Cookie
     * 
     * @param name
     *            名称
     * @param value
     *            值
     * @param maxAge
     *            生存时间（单位秒）
     * @param uri
     *            路径
     */
    public static void setCookie(HttpServletResponse response, String name, String value, String path, int maxAge) {
        Cookie cookie = new Cookie(name, null);
        cookie.setPath(path);
        cookie.setMaxAge(maxAge);
        try {
            cookie.setValue(URLEncoder.encode(value, "utf-8"));
        } catch (UnsupportedEncodingException e) {
            throw new IllegalStateException(e);
        }
        response.addCookie(cookie);
    }

    /**
     * 获得指定Cookie的值
     * 
     * @param name
     *            名称
     * @return 值
     */
    public static String getCookie(HttpServletRequest request, String name) {
        return getCookie(request, null, name, false);
    }

    /**
     * 获得指定Cookie的值，并删除。
     * 
     * @param name
     *            名称
     * @return 值
     */
    public static String getCookie(HttpServletRequest request, HttpServletResponse response, String name) {
        return getCookie(request, response, name, true);
    }

    /**
     * 获得指定Cookie的值
     * 
     * @param request
     *            请求对象
     * @param response
     *            响应对象
     * @param name
     *            名字
     * @param isRemove
     *            是否移除
     * @return 值
     */
    public static String getCookie(HttpServletRequest request, HttpServletResponse response, String name, boolean isRemove) {
        String value = null;
        final Cookie[] cookies = request.getCookies();
        if (nonNull(cookies)) {
            for (Cookie c : cookies) {
                if (nonNull(c) && c.getName().equalsIgnoreCase(name)) {
                    try {
                        value = URLDecoder.decode(c.getValue(), "utf-8");
                    } catch (UnsupportedEncodingException ex) {
                        throw new IllegalStateException(ex);
                    }
                    if (isRemove) {
                        c.setMaxAge(0);
                        response.addCookie(c);
                    }
                }
            }
        }
        return value;
    }

}