正文
Servlet-Cookie源码分析 源码环境：Tomcat8
提示：扫一扫查出行【扫一扫了解最新限行尾号】
复制提示
最近在学习servlet的一些实现细节，阅读了Cookie的源码。
Cookie本质上是服务器发送给客户端（主要是浏览器）的一个会话临时数据。
其源码注释文档的说明：
Creates a cookie, a small amount of information sent by a servlet to a Web browser, saved by the browser, and later sent back to the server. A cookie's value can uniquely identify a client, so cookies are commonly used for session management.
就是说这个东西是个轻量级的信息载体，由服务器创建发送给Web浏览器，之后每一次浏览器发送Http请求访问服务器的时候再传回给服务器，让服务器知道“就是这个用户”。一个Cookie的“值”必须不同来唯一确定一个客户端，所以Cookie经常配合服务器端的Session使用。
在Tomcat8源码中的Cookie源码有接近500行，其中很多东西都是比较占空间的，比如一系列set，get方法，现在拿出其中一部分进行分析。
Cookie的声明：
public class Cookie implements Cloneable, Serializable {
//代码省略
}
说明，这个类的对象可以被复制和持久化。
Cookie的静态部分：
private static final CookieNameValidator validation;
static {
boolean strictNaming;
String prop = System.getProperty("org.apache.tomcat.util.http.ServerCookie.STRICT_NAMING");
if (prop != null) {
strictNaming = Boolean.parseBoolean(prop);
} else {
strictNaming = Boolean.getBoolean("org.apache.catalina.STRICT_SERVLET_COMPLIANCE");
} if (strictNaming) {
validation = new RFC2109Validator();
}
else {
validation = new NetscapeValidator();
}
} private static final long serialVersionUID = 1L;
这里面有一个：CookieNameValidator对象。这个东西是拿来干嘛的呢？实际上Validator是判断一个值是否有效的检测器。也就是说这个对象用于判断Cookie的名字是否有效。那么什么名字是有效的Cookie名字呢？源码文档里面有说明：
The name must conform to RFC 2109. That means it can contain only ASCII alphanumeric characters and cannot contain commas, semicolons, or white space or begin with a $ character. The cookie's name cannot be changed after creation.
就不翻译了。总之，满足这些规则才能被作为Cookie的名字。
而静态代码块里面的strictNaming则表示了一种配置：到底是用RFC2109Validator还是NetscapeValidator进行真正的是否合法的判断。那么这几个类到底有什么区别？实际上是对合法名字判断的严格程度区分的。
源码和我的注释：
class CookieNameValidator { //有效判断器的基类，基本不用这个
private static final String LSTRING_FILE = "javax.servlet.http.LocalStrings";
protected static final ResourceBundle lStrings = ResourceBundle.getBundle(LSTRING_FILE);
protected final BitSet allowed; //这个东西来实现对可取字符区间的控制，其作用原理比较简单：在一个范围内用比特位表示是否有效。
protected CookieNameValidator(String separators) { //构造函数输入一个字符集，这个字符集里面的字符都被作为非法字符对待
allowed = new BitSet(128);
allowed.set(0x20, 0x7f);
for (int i = 0; i < separators.length(); i++) {
char ch = separators.charAt(i);
allowed.clear(ch);
}
}
void validate(String name) { //判断一个那么是否合法
if (name == null || name.length() == 0) { //先是判断是否为null或者为空字符串
throw new IllegalArgumentException(lStrings.getString("err.cookie_name_blank"));
}
if (!isToken(name)) { //调用isToken进行判断。isToken负责判断这个name里面是否包含非法字符，如果有则抛出异常
String errMsg = lStrings.getString("err.cookie_name_is_token");
throw new IllegalArgumentException(MessageFormat.format(errMsg, name));
}
}
private boolean isToken(String possibleToken) { //这个名字是否合法的判断函数
int len = possibleToken.length();
for (int i = 0; i < len; i++) {
char c = possibleToken.charAt(i);
if (!allowed.get(c)) { //把这个字符串的每一个字符拿出来和有效字符集合（上文中的BitSet）进行判断，如果发现一个无效字符则怎个字符串无效
return false;
}
}
return true;
}
}
class NetscapeValidator extends CookieNameValidator {
// the Netscape specification describes NAME=VALUE as
// "a sequence of characters excluding semi-colon, comma and white space"
// we also exclude the '=' character that separates NAME from VALUE
private static final String NETSCAPE_SEPARATORS = ",; " + "="; //等于把这些字符也当做非法字符
NetscapeValidator() {
super(NETSCAPE_SEPARATORS); //通过父类的构造方法传入更多的非法字符，让判断更严格。
}
}
class RFC6265Validator extends CookieNameValidator {
private static final String RFC2616_SEPARATORS = "()<>@,;:\\\"/[]?={} \t"; //更加多的非法字符，更加严格的名字检查
RFC6265Validator() {
super(RFC2616_SEPARATORS);
// special treatment to allow for FWD_SLASH_IS_SEPARATOR property
boolean allowSlash;
String prop = System.getProperty("org.apache.tomcat.util.http.ServerCookie.FWD_SLASH_IS_SEPARATOR");
if (prop != null) {
allowSlash = !Boolean.parseBoolean(prop);
} else {
allowSlash = !Boolean.getBoolean("org.apache.catalina.STRICT_SERVLET_COMPLIANCE");
}
if (allowSlash) {
allowed.set('/');
}
}
}
class RFC2109Validator extends RFC6265Validator { //更加严格，避免以$开头的String作为名字
RFC2109Validator() {
}
@Override
void validate(String name) {
super.validate(name);
if (name.charAt(0) == '$') {
String errMsg = lStrings.getString("err.cookie_name_is_token");
throw new IllegalArgumentException(MessageFormat.format(errMsg, name));
}
}
}
以上源码的注释基本说明白了这个控制Cookie名字是否有效的机制。这个机制保证每一个Cookie的名字的合法性（当然具体要按照什么标准来还要再定）。
接着看Cookie的源码：
private final String name;
private String value; private int version = 0; // ;Version=1 ... means RFC 2109 style //
// Attributes encoded in the header's cookie fields.
//
private String comment; // ;Comment=VALUE ... describes cookie's use
private String domain; // ;Domain=VALUE ... domain that sees cookie
private int maxAge = -1; // ;Max-Age=VALUE ... cookies auto-expire
private String path; // ;Path=VALUE ... URLs that see the cookie
private boolean secure; // ;Secure ... e.g. use SSL
private boolean httpOnly; // Not in cookie specs, but supported by browsers
name和Value为最重要的两个量，一个是Cookie的名字，一个是它的值，名字可以重复，值必须唯一。这里有个小细节，注释上明确说了名字在创建之后不可以再更改，那么这个final起到什么效果呢？就是起到阻止更改的效果。String对象的每一次修改，都是new 一个String，其值为更改之后的值，再返回新的对象，让原来的引用指向这个新的对象，而不是真的修改了这个对象的内容。把它修饰为final之后，这个引用就不可以再变化，也就不能修改其值了。
下方的实例变量为Cookie的“属性”。Cookie的注释也明确提到，很多浏览器的支持不是很完善，使用要谨慎。
path：指明Cookie对应的页面（通常是一个目录），这个目录的子页面都可以访问这个Cookie，其他则不能访问，如果要设置为全局可以访问的，则设置为/。
domain：指定关联的WEB服务器域名。
secure:指定是否安全传输数据，或者为空或者为secure，如果是空用不安全的http，如果是secure用https或者别的加密方式。这个只是加密传输的内容而不是本地保存的Cookie。
maxAge：最大生命周期。整数，单位为秒，设置这个Cookie的过期时间。如果为负数则关闭浏览器失效，本地不保存。
comment：浏览器显示这个Cookie的时候显示出来的对这个Cookie的意义的说明。
version：Cookie使用的版本号。0表示遵循Netscape的Cookie规范，1表示遵循W3C的RFC 2109规范
httpOnly：cookie的httponly属性。若此属性为true，则只有在http请求头中会带有此cookie的信息，而不能通过document.cookie来访问此cookie。
构造方法：
public Cookie(String name, String value) {
validation.validate(name);
this.name = name;
this.value = value;
}
比较直白：检查名字的合法性，然后注入。
后面跟了一大堆get和set方法，都是关于Cookie的那些属性的。
