引用
作者：张逸
java的类对外而言只有一种面貌，但封装在类内部的形态却可以丰富多彩。嵌套类在这其中，扮演了极为重要的角色。它既丰富了类的层次，又可以灵活控制内部结构的访问限制与粒度，使得我们在开放性与封闭性之间、公开接口与内部实现之间取得适度的平衡。
嵌套类之所以能扮演这样的设计平衡角色，是因为嵌套类与其主类的关系不同，主类的所有成员对嵌套类而言都是完全开放的，主类的私有成员可以被嵌套类访问，而嵌套类则可以被看做是类边界中自成一体的高内聚类而被主类调用。因此，嵌套类的定义其实就是对类内部成员的进一步封装。虽然在一个类中定义嵌套类并不能减小类定义的规模，但由于嵌套类体现了不同层次的封装，使得一个相对较大的主类可以显得更有层次感，不至于因为成员过多而显得过于混乱。
当一个类的业务逻辑非常复杂，且它承担的职责却又不足以单独分离为另外的类型时，内部嵌套类尤其是静态嵌套类就会变得非常有用。它是帮助我们组织类内部代码的利器。通过阅读顶级的java开源项目，我们发现内部嵌套类通常用于几种情况。
封装 builder
builder模式常常用于组装一个类，它通过更加流畅的接口形式简化构建组成元素的逻辑。在java中，除非必要，我们一般会将一个类的builder定义为内部嵌套类。这几乎已经成为一种惯有模式了。
例如框架airlift定义了request类，它是客户端请求对象的一个封装。组成一个request对象需要诸如uri、header、http verb、body等元素，且这些元素的组成会因为客户请求的不同而调用不同的组装方法。这是典型的builder模式应用场景。让我们看看在presto框架下，它如何调用airlift提供的request及对应的builder：
@threadsafe
public class statementclient implements closeable {
private request buildqueryrequest(clientsession session, string query) {
request.builder builder = preparerequest(preparepost(), uribuilderfrom(session.getserver()).replacepath("/v1/statement").build())
.setbodygenerator(createstaticbodygenerator(query, utf_8));
if (session.getsource() != null) {
builder.setheader(prestoheaders.presto_source, session.getsource());
}
if (session.getclientinfo() != null) {
builder.setheader(prestoheaders.presto_client_info, session.getclientinfo());
}
if (session.getcatalog() != null) {
builder.setheader(prestoheaders.presto_catalog, session.getcatalog());
}
if (session.getschema() != null) {
builder.setheader(prestoheaders.presto_schema, session.getschema());
}
builder.setheader(prestoheaders.presto_time_zone, session.gettimezone().getid());
if (session.getlocale() != null) {
builder.setheader(prestoheaders.presto_language, session.getlocale().tolanguagetag());
}
map property = session.getproperties();
for (entry entry : property.entryset()) {
builder.addheader(prestoheaders.presto_session, entry.getkey() "=" entry.getvalue());
}
map statements = session.getpreparedstatements();
for (entry entry : statements.entryset()) {
builder.addheader(prestoheaders.presto_prepared_statement, urlencode(entry.getkey()) "=" urlencode(entry.getvalue()));
}
builder.setheader(prestoheaders.presto_transaction_id, session.gettransactionid() == null ? "none" : session.gettransactionid());
return builder.build();
}
private request.builder preparerequest(request.builder builder, uri nexturi) {
builder.setheader(prestoheaders.presto_user, user);
builder.setheader(user_agent, user_agent_value)
.seturi(nexturi);
return builder;
}
}
显然，statementclient会根据clientsession对象的不同情况，构造不同的request。由于引入了builder模式，则这种构造request对象的职责到request.builder对象。观察该对象的使用：
request.builder builder = preparerequest(...);
builder类被定义为request的静态嵌套类，以下为airlift框架的源代码：
public class request {
public static class builder {
private uri uri;
private string method;
private final listmultimap headers = arraylistmultimap.create();
private bodygenerator bodygenerator;
public builder() {
}
public static request.builder preparehead() {
return (new request.builder()).setmethod("head");
}
public static request.builder prepareget() {
return (new request.builder()).setmethod("get");
}
public static request.builder preparepost() {
return (new request.builder()).setmethod("post");
}
public static request.builder prepareput() {
return (new request.builder()).setmethod("put");
}
public static request.builder preparedelete() {
return (new request.builder()).setmethod("delete");
}
public static request.builder fromrequest(request request) {
request.builder requestbuilder = new request.builder();
requestbuilder.setmethod(request.getmethod());
requestbuilder.setbodygenerator(request.getbodygenerator());
requestbuilder.seturi(request.geturi());
iterator var2 = request.getheaders().entries().iterator();
while (var2.hasnext()) {
entry entry = (entry)var2.next();
requestbuilder.addheader((string)entry.getkey(), (string)entry.getvalue());
}
return requestbuilder;
}
public request.builder seturi(uri uri) {
this.uri = request.validateuri(uri);
return this;
}
public request.builder setmethod(string method) {
this.method = method;
return this;
}
public request.builder setheader(string name, string value) {
this.headers.removeall(name);
this.headers.put(name, value);
return this;
}
public request.builder addheader(string name, string value) {
this.headers.put(name, value);
return this;
}
public request.builder setbodygenerator(bodygenerator bodygenerator) {
this.bodygenerator = bodygenerator;
return this;
}
public request build() {
return new request(this.uri, this.method, this.headers, this.bodygenerator);
}
}
}
当一个类的构建逻辑非常复杂，并有多种不同的组合可能性时，我们会倾向于使用builder模式来封装这种变化的组装逻辑。惯用的模式是将builder类定义为公有静态嵌套类，很多java实践证实了这一做法。
封装 iterator
当我们需要在类中提供自定义的迭代器，且又不需要将该迭代器的实现对外公开时，都可以通过嵌套类实现一个内部迭代器。这是迭代器模式的一种惯用法。例如在presto框架中，定义了属于自己的prestoresultset类，继承自jdbc的resultset，并重写了父类的迭代方法next()。next方法的迭代职责又委派给了一个内部迭代器results：
public class prestoresultset implements resultset {
private final iterator> results;
@override
public boolean next() throws sqlexception {
checkopen();
try {
if (!results.hasnext()) {
row.set(null);
return false;
}
row.set(results.next());
return true;
}
catch (runtimeexception e) {
if (e.getcause() instanceof sqlexception) {
throw (sqlexception) e.getcause();
}
throw new sqlexception("error fetching results", e);
}
}
}
而这个results实则是一个内部迭代器：
public class prestoresultset implements resultset {
private static class resultspageiterator
extends abstractiterator>> {
//......
}
}
resultspageiterator迭代器继承自guava框架定义的abstractiterator
，间接实现了接口iterator。
封装内部概念
编写整洁代码的实践告诉我们：类的定义要满足“单一职责原则”，这样的类才是专注的。编写可扩展代码的实践也告诉我们：类的定义要满足“单一职责原则”，如此才能保证只有一个引起变化的原因。然而，即使类只履行一个专注的职责，也可能因为过于复杂的业务逻辑而导致设计出相对比较庞大的类（真实项目总是要比玩具项目复杂100倍）。这时，我们会面临左右为难的选择。倘若不将职责分离到另外的单独类中，则该类就过于庞大，导致内部逻辑过于复杂；倘若将部分逻辑分离出去，又会导致类的数量过多，导致系统复杂度增加。这时，我们可以用嵌套类来封装内部概念，定义属于自己的数据与行为，在主类内部形成更加清晰的职责边界，却没有引起系统类数量的增加，算是一种折中的设计手法。
当然，我们必须谨记的一点是：究竟职责应该定义在独立类中，还是定义在附属的嵌套类，判断标准不是看代码量以及类的规模，而是看这些需要封装的逻辑究竟属于内部概念，还是外部概念。
例如presto框架的hivewriterfactory类。它是一个工厂类，创建的产品为hivewriter。在创建过程中，需要根据列名、列类型以及列的hive类型进行组合，并将组合后的结果赋值给properties类型的schema。
这些值并不需要公开，如果不对其进行封装，则存在问题：
- 没有体现领域概念，只有散乱的三种类型的变量
- 无法将其作为整体放入到集合中，因而也无法调用集合的api对其进行转换
针对hive所要操作的数据，列名、列类型以及列的hive类型这三个散乱概念实际上表达的是数据列的概念，于是就可以在这个工厂类中定义嵌套类来封装这些概念与逻辑：
public class hivewriterfactory {
private static class datacolumn {
private final string name;
private final type type;
private final hivetype hivetype;
public datacolumn(string name, type type, hivetype hivetype) {
this.name = requirenonnull(name, "name is null");
this.type = requirenonnull(type, "type is null");
this.hivetype = requirenonnull(hivetype, "hivetype is null");
}
public string getname() {
return name;
}
public type gettype() {
return type;
}
public hivetype gethivetype() {
return hivetype;
}
}
}
在封装为datacolumn嵌套类后，就可以将其放入到list集合中，然后像如下代码那样对其进行操作：
schema.setproperty(meta_table_columns, datacolumns.stream()
.map(datacolumn::getname)
.collect(joining(",")));
schema.setproperty(meta_table_column_types, datacolumns.stream()
.map(datacolumn::gethivetype)
.map(hivetype::gethivetypename)
.collect(joining(":")));
在开发过程中，我们还会经常遇见一种典型的数据结构，它需要将两个值对应起来形成一种映射。这种数据结构通常称之为tuple。虽然在java 7已经提供了这种简便的结构（scala在一开始就提供了tuple结构，而且还提供了._1和._2的快捷访问方式），但这种结构是通用的，不利于体现出业务概念。当这种结构仅仅在一个类的内部使用时，就是嵌套类登上舞台的时候了。
例如我们要建立type与object之间的映射关系，并被用在一个sql语句的解析器中充当解析过程中的元数据，就可以定义为类typeandvalue，命名直白，清晰可见：
public class sqlstatementparser {
private list accumulator = new arraylist<>();
public preparedstatement buildsql(jdbcclient client, connection connection, string catalog, string schema, string table, list columns) {
stringbuilder sql = new stringbuilder();
string columnnames = columns.stream()
.map(jdbccolumnhandle::getcolumnname)
.map(this::quote)
.collect(joining(", "));
sql.append("select ");
sql.append(columnnames);
if (columns.isempty()) {
sql.append("null");
}
sql.append(" from ");
if (!isnullorempty(catalog)) {
sql.append(quote(catalog)).append('.');
}
if (!isnullorempty(schema)) {
sql.append(quote(schema)).append('.');
}
sql.append(quote(table));
list clauses = toconjuncts(columns, accumulator);
if (!clauses.isempty()) {
sql.append(" where ")
.append(joiner.on(" and ").join(clauses));
}
preparedstatement statement = client.getpreparedstatement(connection, sql.tostring());
for (int i = 0; i < accumulator.size(); i ) {
typeandvalue typeandvalue = accumulator.get(i);
if (typeandvalue.gettype().equals(biginttype.bigint)) {
statement.setlong(i 1, (long) typeandvalue.getvalue());
}
else if (typeandvalue.gettype().equals(integertype.integer)) {
statement.setint(i 1, ((number) typeandvalue.getvalue()).intvalue());
}
else if (typeandvalue.gettype().equals(smallinttype.smallint)) {
statement.setshort(i 1, ((number) typeandvalue.getvalue()).shortvalue());
}
else if (typeandvalue.gettype().equals(tinyinttype.tinyint)) {
statement.setbyte(i 1, ((number) typeandvalue.getvalue()).bytevalue());
}
else if (typeandvalue.gettype().equals(doubletype.double)) {
statement.setdouble(i 1, (double) typeandvalue.getvalue());
}
else if (typeandvalue.gettype().equals(realtype.real)) {
statement.setfloat(i 1, intbitstofloat(((number) typeandvalue.getvalue()).intvalue()));
}
else if (typeandvalue.gettype().equals(booleantype.boolean)) {
statement.setboolean(i 1, (boolean) typeandvalue.getvalue());
}
else if (typeandvalue.gettype().equals(datetype.date)) {
long millis = days.tomillis((long) typeandvalue.getvalue());
statement.setdate(i 1, new date(utc.getmilliskeeplocal(datetimezone.getdefault(), millis)));
}
else if (typeandvalue.gettype().equals(timetype.time)) {
statement.settime(i 1, new time((long) typeandvalue.getvalue()));
}
else if (typeandvalue.gettype().equals(timewithtimezonetype.time_with_time_zone)) {
statement.settime(i 1, new time(unpackmillisutc((long) typeandvalue.getvalue())));
}
else if (typeandvalue.gettype().equals(timestamptype.timestamp)) {
statement.settimestamp(i 1, new timestamp((long) typeandvalue.getvalue()));
}
else if (typeandvalue.gettype().equals(timestampwithtimezonetype.timestamp_with_time_zone)) {
statement.settimestamp(i 1, new timestamp(unpackmillisutc((long) typeandvalue.getvalue())));
}
else if (typeandvalue.gettype() instanceof varchartype) {
statement.setstring(i 1, ((slice) typeandvalue.getvalue()).tostringutf8());
}
else {
throw new unsupportedoperationexception("can't handle type: " typeandvalue.gettype());
}
}
return statement;
}
private static class typeandvalue {
private final type type;
private final object value;
public typeandvalue(type type, object value) {
this.type = requirenonnull(type, "type is null");
this.value = requirenonnull(value, "value is null");
}
public type gettype() {
return type;
}
public object getvalue() {
return value;
}
}
}
typeandvalue内部类的封装，有效地体现了类型与值之间的映射关系，改进了代码的可读性。事实上，以上代码还有可堪改进的空间，例如我们可以利用类的封装性，将类型判断的语句封装为方法，例如isbigint()、isinteger()、isdouble()、istimewithtimezone()、isvarchartype()等方法，则前面的一系列分支语句会变得更流畅一些：
for (int i = 0; i < accumulator.size(); i ) {
typeandvalue typeandvalue = accumulator.get(i);
if (typeandvalue.isbigint())) {
statement.setlong(i 1, (long) typeandvalue.getvalue());
}
else if (typeandvalue.isinteger())) {
statement.setint(i 1, ((number) typeandvalue.getvalue()).intvalue());
}
else if (typeandvalue.issmallint())) {
statement.setshort(i 1, ((number) typeandvalue.getvalue()).shortvalue());
}
//……
else {
throw new unsupportedoperationexception("can't handle type: " typeandvalue.gettype());
}
}
作为内部map的key
假定一个类的内部需要用到map集合，而该集合对象又仅仅在内部使用，并不会公开给外部调用者。对于这样的map集合，倘若java基本类型或者字符串无法承担key的作用，就可以定义一个内部静态嵌套类作为该map的key。注意，由于嵌套类要作为唯一不重复的key，且该类型为引用类型，因而需要重写equals()方法与hashcode()方法，视情况还应该重写tostring()方法。
例如在一个类中需要创建一个map用以存储多个指标对象，但该指标的key由两个bytebuffer对象联合组成，就可以封装为一个内部嵌套类：
private final map metrics = new hashmap<>();
private static class metricskey {
public final bytebuffer row;
public final bytebuffer family;
public metricskey(bytebuffer row, bytebuffer family) {
requirenonnull(row, "row is null");
requirenonnull(family, "family is null");
this.row = row;
this.family = family;
}
@override
public boolean equals(object obj) {
if (this == obj) {
return true;
}
if ((obj == null) || (getclass() != obj.getclass())) {
return false;
}
metricskey other = (metricskey) obj;
return objects.equals(this.row, other.row)
&& objects.equals(this.family, other.family);
}
@override
public int hashcode() {
return objects.hash(row, family);
}
@override
public string tostring() {
return tostringhelper(this)
.add("row", new string(row.array(), utf_8))
.add("family", new string(row.array(), utf_8))
.tostring();
}
}
实现外部接口
当我们在一个类的内部需要使用一个外部接口，且该接口的实现逻辑又比较复杂，而在类的外部又不存在重用的可能，此时就可以定义一个私有的内部嵌套类去实现该接口。
在presto框架的benchmarksuite类内部，调用了abstractbenchmark类的runbenchmark()方法，该方法需要传入benchmarkresulthook接口类型的对象：
public void runbenchmark(@nullable benchmarkresulthook benchmarkresulthook) {}
而benchmarkresulthook是一个独立定义的接口：
public interface benchmarkresulthook {
benchmarkresulthook addresults(map results);
void finished();
}
在类的内部，定义了实现benchmarkresulthook接口的内部嵌套类：
private static class forwardingbenchmarkresultwriter implements benchmarkresulthook {}
然后在benchmarksuite中就可以使用它：
benchmark.runbenchmark(
new forwardingbenchmarkresultwriter(
immutablelist.of(
new jsonbenchmarkresultwriter(jsonout),
new jsonavgbenchmarkresultwriter(jsonavgout),
new simplelinebenchmarkresultwriter(csvout),
new odsbenchmarkresultwriter("presto.benchmark." benchmark.getbenchmarkname(), odsout)
)
)
);
实现外部接口还有一种特殊情况是利用嵌套类实现一个函数接口。虽然在多数情况下，当我们在使用函数接口时，会使用lambda表达式来实现该接口，其本质其实是一个函数。然而，当一个函数的实现相对比较复杂，且有可能被类的内部多处重用时，就不能使用lambda表达式了。可是针对这种情形，确乎又没有必要定义单独的类去实现该函数接口，这时就是嵌套类的用武之地了。
例如在presto框架的hivepagesource类中有一个方法createcoercer()，它返回的类型是一个函数接口类型function。方法的实现会根据hive的类型决定返回的函数究竟是什么。目前支持以下四种情形：
- integer数字转换为varchar
- varchar转换为integer数字
- integer数字的提升
- float转换为double
这四种情形对应的coercer其实都是一个函数block -> block，但这个转换的逻辑比较复杂，尤其针对“integer数字的提升”情形，还存在多个条件分支的判断。于是，presto就在hivepagesource定义了如下四个嵌套类，并且都实现了函数接口function：
public class hivepagesource implements connectorpagesource {
private static class integernumberupscalecoercer implements function {
private final type fromtype;
private final type totype;
public integernumberupscalecoercer(type fromtype, type totype)
{
this.fromtype = requirenonnull(fromtype, "fromtype is null");
this.totype = requirenonnull(totype, "totype is null");
}
@override
public block apply(block block)
{
//...
}
}
private static class integernumbertovarcharcoercer implements function {
private final type fromtype;
private final type totype;
public integernumbertovarcharcoercer(type fromtype, type totype)
{
this.fromtype = requirenonnull(fromtype, "fromtype is null");
this.totype = requirenonnull(totype, "totype is null");
}
@override
public block apply(block block)
{
//...
}
}
private static class varchartointegernumbercoercer implements function {
private final type fromtype;
private final type totype;
private final long minvalue;
private final long maxvalue;
public varchartointegernumbercoercer(type fromtype, type totype) {
//...
}
@override
public block apply(block block) {
//...
}
}
private static class floattodoublecoercer implements function {
@override
public block apply(block block) {
//...
}
}
}
封装内部常量
如果一个类的内部需要用到大量常量，而这些常量却没有重用的可能，换言之，这些常量无需公开，仅作为内部使用。这时，我们可以通过嵌套类对这些常量进行归类，既便于调用，又提高了可读性，形成一种组织良好的代码结构。
public class metadataloader {
private static class ipaddressconstants {
// ipv4: 255.255.255.255 - 15 characters
// ipv6: ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff - 39 characters
// ipv4 embedded into ipv6: ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255 - 45 characters
private static final int ipv4_string_max_length = 15;
private static final int ipv6_string_max_length = 39;
private static final int embedded_ip_address_string_max_length = 45;
}
private static class typeconstants {
private static final biginttype bigint = new biginttype();
private static final booleantype boolean = new booleantype();
private static final doubletype double = new doubletype();
private static final timestamptype timestamp = new timestamptype();
}
//……
}
内部重用
有些重用代码块，它的重用单元比方法要多一些，却又不成其为单独的类，因为它只在类的内部被重用，这时就可以将其定义为嵌套类，以利于内部重用。
例如，在一个并发处理程序的query类中，我们需要根据一个布尔标志来判断当前线程是否需要中断。中断线程的逻辑无法封装在一个私有方法中。如果将这个逻辑直接写到调用方法中，有可能干扰到主要逻辑的阅读，为了提供代码的可读性，query类定义了一个内部嵌套类threadinterruptor，用以封装中断当前线程的逻辑：
public class query implements closeable {
private final atomicboolean ignoreuserinterrupt = new atomicboolean();
private final atomicboolean userabortedquery = new atomicboolean();
public void pageoutput(outputformat format, list fieldnames) {
try (pager pager = pager.create();
threadinterruptor clientthread = new threadinterruptor();
writer writer = createwriter(pager);
outputhandler handler = createoutputhandler(format, writer, filednames)) {
if (!pager.isnullpager()) {
ignoreuserinterrupt.set(true);
pager.getfinishfuture().thenrun(() -> {
userabortedquery.set(true);
ignoreuserinterrupt.set(false);
clientthread.interrupt();
});
}
handler.processrow(client);
} catch (runtimeexception | ioexception e) {
if (userabortedquery.get() && !(e instanceof queryabortedexception)) {
throw new queryabortedexception(e);
}
throw e;
}
}
private static class threadinterruptor implements closeable {
private final thread thread = thread.currentthread();
private final atomicboolean processing = new atomicboolean(true);
public synchronized void interrupt() {
if (processing.get()) {
thread.interrupt();
}
}
@override
public synchronized void close() {
processing.set(false);
}
}
}
注意，由于threadinterruptor对象要放到try语句块中，因而需要实现closeable接口，且需要通过try调用close()方法时，将processing标志变量置为false。
内部异常
这算是内部重用的一种特殊情形，即对异常的内部重用。当我们需要抛出一个异常，且希望抛出的消息能够体现该异常场景，又或者该异常需要携带的内容不仅仅包括消息或错误原因时，都需要我们自定义异常。倘若该自定义异常没有外部公开的必要，就可以通过嵌套类定义一个内部异常。
例如我们希望一个异常在抛出时能够携带类型信息，且该异常仅为内部使用，就可以这样来定义：
public class failureinfo {
private static class failureexception
extends runtimeexception {
private final string type;
failureexception(string type, string message, failureexception cause) {
super(message, cause, true, true);
this.type = requirenonnull(type, "type is null");
}
public string gettype() {
return type;
}
@override
public string tostring() {
string message = getmessage();
if (message != null) {
return type ": " message;
}
return type;
}
}
}
无论嵌套类的使用形式如何多样，体现的价值又如何地梅兰秋菊各擅胜场，根本的原理还是逃不开面向对象设计的基本思想，即通过封装体现内聚的概念，从而利于重用，应对变化，或者就是单纯地组织代码，让代码的结构变得更加清晰。尤其是在相对复杂的真实项目中，如何控制对象类型的数量，又不至于违背“单一职责原则”，使用嵌套类是一条不错的中间路线选择。
您还没有登录,请您登录后再发表评论