首页 > 数据库技术 > 详细

HSQLDB源码阅读 （一）从程序入口开始

时间：2014-10-30 13:13:36      阅读：303      评论：0      收藏：0      [点我收藏+]
最近一段业余时间，学围棋、五子棋、黑白棋、2048，完事之后，学一点就学不进去了——年龄大了，学什么都困难了。
此为题外话，想来想去，也许业余时间只有读读代码，才学得进去吧。

hsqldb是一个开放源代码的JAVA数据库，其具有标准的SQL语法和JAVA接口。当然为作源码阅读的主要原因是代码量比较小，作为首次阅读源码，这很重要。

于是就从 http://hsqldb.org/ 下载了源码。
源码是下载下来了，src目录下，这么多文件以及文件夹，之前也没有阅读一个完整源代码的经验，从何开始呢？
bubuko.com,布布扣

原本想一个个文件的看吧，突然灵光一闪，应该从程序入口开始。
hsqldb可以使用命令行方式 java -cp xxxx org.hsqldb.server.Server 或者  java -cp xxxx org.hsqldb.server.WebServer的方式，作为服务器启动。
就从Server/WebServer的main方法开始。


点击(此处)折叠或打开

  1. public static void main(String[] args) {

  3.         HsqlProperties argProps = null;

  5.         argProps = HsqlProperties.argArrayToProps(args,
  6.                 ServerProperties.sc_key_prefix);

  8.         String[] errors = argProps.getErrorKeys();

  10.         if (errors.length != 0) {
  11.             System.out.println("no value for argument:" + errors[0]);
  12.             printHelp("server.help");

  14.             return;
  15.         }

  17.         String propsPath = argProps.getProperty(ServerProperties.sc_key_props);
  18.         String propsExtension = "";

  20.         if (propsPath == null) {
  21.             propsPath = "server";
  22.             propsExtension = ".properties";
  23.         } else {
  24.             argProps.removeProperty(ServerProperties.sc_key_props);
  25.         }

  27.         propsPath = FileUtil.getFileUtil().canonicalOrAbsolutePath(propsPath);

  29.         ServerProperties fileProps = ServerConfiguration.getPropertiesFromFile(
  30.             ServerConstants.SC_PROTOCOL_HSQL, propsPath, propsExtension);
  31.         ServerProperties props =
  32.             fileProps == null
  33.             ? new ServerProperties(ServerConstants.SC_PROTOCOL_HSQL)
  34.             : fileProps;

  36.         props.addProperties(argProps);
  37.         ServerConfiguration.translateDefaultDatabaseProperty(props);

  39.         // Standard behaviour when started from the command line
  40.         // is to halt the VM when the server shuts down. This may, of
  41.         // course, be overridden by whatever, if any, security policy
  42.         // is in place.
  43.         ServerConfiguration.translateDefaultNoSystemExitProperty(props);
  44.         ServerConfiguration.translateAddressProperty(props);

  46.         // finished setting up properties;
  47.         Server server = new Server();

  49.         try {
  50.             server.setProperties(props);
  51.         } catch (Exception e) {
  52.             server.printError("Failed to set properties");
  53.             server.printStackTrace(e);

  55.             return;
  56.         }

  58.         // now messages go to the channel specified in properties
  59.         server.print("Startup sequence initiated from main() method");

  61.         if (fileProps != null) {
  62.             server.print("Loaded properties from [" + propsPath
  63.                          + propsExtension + "]");
  64.         } else {
  65.             server.print("Could not load properties from file");
  66.             server.print("Using cli/default properties only");
  67.         }

  69.         server.start();
  70.     }
在main方法中，主要完成参数的读取、new Server对象设置参数后调用start方法。
在此方法中，声明一个HsqlProperties类来读取、解析参数是一个不错的代码方式，可以将配置项都体现在该类中——如果代码都在Server(也即main所在的类）实现的话，那就显得Server职责过多。

下面再看server.start方法

点击(此处)折叠或打开

  1. public int start() {

  3.         printWithThread("start() entered");

  5.         int previousState = getState();

  7.         if (serverThread != null) {
  8.             printWithThread("start(): serverThread != null; no action taken");

  10.             return previousState;
  11.         }

  13.         setState(ServerConstants.SERVER_STATE_OPENING);

  15.         serverThread = new ServerThread("HSQLDB Server ");

  17.         if (isDaemon) {
  18.             serverThread.setDaemon(true);
  19.         }

  21.         serverThread.start();

  23.         // call synchronized getState() to become owner of the Server Object‘s monitor
  24.         while (getState() == ServerConstants.SERVER_STATE_OPENING) {
  25.             try {
  26.                 Thread.sleep(100);
  27.             } catch (InterruptedException e) {}
  28.         }

  30.         printWithThread("start() exiting");

  32.         return previousState;
  33.     }
这里开启了一个后台线程，去处理启动数据库，然后开启端口监听，而主线程，则在这里每隔100毫秒检查一下状态，一直等到启动结束或者关闭等状态。
这里要开一个新的线程，因为当前线程可能是别的地方调用了方法，需要返回值的。

那我们再来看看程序的主体工作又是在做什么，先是ServerThread

点击(此处)折叠或打开

  1. private class ServerThread extends Thread {

  3.         /**
  4.          * Constructs a new thread in which to execute the run method
  5.          * of this server.
  6.          *
  7.          * @param name The thread name
  8.          */
  9.         ServerThread(String name) {

  11.             super(name);

  13.             setName(name + ‘@‘ + Integer.toString(Server.this.hashCode(), 16));
  14.         }

  16.         /**
  17.          * Executes the run() method of this server
  18.          */
  19.         public void run() {
  20.             Server.this.run();
  21.             printWithThread("ServerThread.run() exited");
  22.         }
  23.     }
这里代码很简单，这是Server的一个内部类，然后又回到Server.run方法去了。

点击(此处)折叠或打开

  1. private void run() {

  3.         StopWatch sw;
  4.         ThreadGroup tg;
  5.         String tgName;

  7.         printWithThread("run() entered");
  8.         print("Initiating startup sequence...");
  9.         printProperties();

  11.         sw = new StopWatch();

  13.         setServerError(null);

  15.         try {

  17.             // Faster init first:
  18.             // It is huge waste to fully open the databases, only
  19.             // to find that the socket address is already in use
  20.             openServerSocket();
  21.         } catch (Exception e) {
  22.             setServerError(e);
  23.             printError("run()/openServerSocket(): ");
  24.             printStackTrace(e);
  25.             shutdown(true);

  27.             return;
  28.         }

  30.         tgName = "HSQLDB Connections @"
  31.                  + Integer.toString(this.hashCode(), 16);
  32.         tg = new ThreadGroup(tgName);

  34.         tg.setDaemon(false);

  36.         serverConnectionThreadGroup = tg;

  38.         // Mount the databases this server is supposed to host.
  39.         // This may take some time if the databases are not all
  40.         // already open.
  41.         if (!openDatabases()) {
  42.             setServerError(null);
  43.             printError("Shutting down because there are no open databases");
  44.             shutdown(true);

  46.             return;
  47.         }

  49.         // At this point, we have a valid server socket and
  50.         // a valid hosted database set, so its OK to start
  51.         // listening for connections.
  52.         setState(ServerConstants.SERVER_STATE_ONLINE);
  53.         print(sw.elapsedTimeToMessage("Startup sequence completed"));
  54.         printServerOnlineMessage();

  56.         // isShuttingDown is only read after socket connections are ‘accept‘ed.
  57.         isShuttingDown = false; // In case shutdown was aborted previously.

  59.         try {
  60.             /*
  61.              * This loop is necessary for UNIX w/ Sun Java 1.3 because
  62.              * in that case the socket.close() elsewhere will not
  63.              * interrupt this accept().
  64.              */
  65.             while (socket != null) {
  66.                 try {
  67.                     handleConnection(socket.accept());
  68.                 } catch (java.io.InterruptedIOException iioe) {}
  69.             }
  70.         } catch (IOException ioe) {
  71.             if (getState() == ServerConstants.SERVER_STATE_ONLINE) {
  72.                 setServerError(ioe);
  73.                 printError(this + ".run()/handleConnection(): ");
  74.                 printStackTrace(ioe);
  75.             }
  76.         } catch (Throwable t) {
  77.             printWithThread(t.toString());
  78.         } finally {
  79.             shutdown(false); // or maybe getServerError() != null?
  80.         }
  81.     }
写过tcp服务端的人可能比较熟悉，就是绑定socket端口，然后while循环一直监听到有客户端进行连接，有连接就调用handleConnection进行处理。


点击(此处)折叠或打开

  1. public void handleConnection(Socket s) {

  3.         Thread t;
  4.         Runnable r;
  5.         String ctn;

  7.         printWithThread("handleConnection(" + s + ") entered");

  9.         if (!allowConnection(s)) {
  10.             try {
  11.                 s.close();
  12.             } catch (Exception e) {}

  14.             printWithThread("allowConnection(): connection refused");
  15.             printWithThread("handleConnection() exited");

  17.             return;
  18.         }

  20.         // Maybe set up socket options, SSL
  21.         // Session tracing/callbacks, etc.
  22.         if (socketFactory != null) {
  23.             socketFactory.configureSocket(s);
  24.         }

  26.         if (serverProtocol == ServerConstants.SC_PROTOCOL_HSQL) {
  27.             r = new ServerConnection(s, this);
  28.             ctn = ((ServerConnection) r).getConnectionThreadName();
  29.         } else {
  30.             r = new WebServerConnection(s, (WebServer) this);
  31.             ctn = ((WebServerConnection) r).getConnectionThreadName();
  32.         }

  34.         t = new Thread(serverConnectionThreadGroup, r, ctn);

  36.         t.start();
  37.         printWithThread("handleConnection() exited");
  38.     }
在这里，为每一个客户端新建一个线程进行处理（线程放入ThreadGroup中），处理函数转接到ServerConnection/WebServerConnection——分别对应不同的客户端协议处理。

至此，Server这个入口基本上清晰了。
1. 解析配置（含命令行的、配置文件的）
2. 声明一个服务监听线程，打开socket端口，进行监听
3. 对于每一个连接而来的客户端，声明一个线程，进行处理
4. 下一步客户端协议的请求响应处理，进入ServerConnection/WebServerConnection中

WebServer继承自Server，内容基本一样。

[相关源码文件]
Server.java
WebServer.java
HsqlProperties.java
ServerProperties.java
ServerConfiguration.java
HsqlSocketFactory.java









HSQLDB源码阅读 （一）从程序入口开始

原文：http://blog.chinaunix.net/uid-29966746-id-4561171.html
踩
(0)
赞
(0)
   
举报
评论 一句话评论（0）
分享档案
更多>
2021年09月23日 (328)
2021年09月24日 (313)
2021年09月17日 (191)
2021年09月15日 (369)
2021年09月16日 (411)
2021年09月13日 (439)
2021年09月11日 (398)
2021年09月12日 (393)
2021年09月10日 (160)
2021年09月08日 (222)
最新文章
更多>
教程昨日排行
更多>
友情链接
汇智网   PHP教程   插件网  
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣，分享程序人生！