增加注释

shikeying

2024-02-22 0632a02beb78705dc93b760c7bfa86ecedacb970

增加注释

 walker-ml-openocr/src/main/java/com/walker/openocr/idcard/IdCardObject.java

@@ -33,6 +33,42 @@
    private String dateStart;
    private String dateEnd;

    public void setName(String name) {
        this.name = name;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public void setNation(String nation) {
        this.nation = nation;
    }

    public void setBirthday(String birthday) {
        this.birthday = birthday;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    public void setCardNo(String cardNo) {
        this.cardNo = cardNo;
    }

    public void setSignOffice(String signOffice) {
        this.signOffice = signOffice;
    }

    public void setDateStart(String dateStart) {
        this.dateStart = dateStart;
    }

    public void setDateEnd(String dateEnd) {
        this.dateEnd = dateEnd;
    }

    public String getName() {
        return name;
    }

 walker-tcp/src/main/java/com/walker/tcp/netty/WebSocketNettyHandler.java

@@ -33,6 +33,24 @@
        return uri;
    }

    /**
     * 设置外部配置的websocket访问地址。
     * <pre>
     *     1) 该地址是浏览器可访问的最终地址，如：ws://my.com/websocket 或 wss://my.com/wss
     *     2) 引擎本身并不会生成地址，代码中log日志中websocket仅是调试并非真正路径
     *     3) 引擎仅监听设置的端口（默认60000），通常在 nginx 配置中，代理该端口即可，如：
     *
     *     ...
     *     location /wss {
     *         proxy_pass http://my.com:60000;
     *         proxy_http_version 1.1;
     *         proxy_set_header Upgrade $http_upgrade;
     *         proxy_set_header Connection "Upgrade";
     *     }
     *
     * </pre>
     * @param uri
     */
    public void setUri(String uri) {
        this.uri = uri;
    }

 walker-tcp/src/main/java/com/walker/tcp/netty/WebSocketServerInitializer.java

@@ -6,7 +6,15 @@
import io.netty.handler.codec.http.HttpServerCodec;
import io.netty.handler.logging.LogLevel;
import io.netty.handler.logging.LoggingHandler;
import io.netty.handler.ssl.SslHandler;
import io.netty.handler.stream.ChunkedWriteHandler;

import javax.net.ssl.KeyManagerFactory;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLEngine;
import java.io.FileInputStream;
import java.io.InputStream;
import java.security.KeyStore;

public class WebSocketServerInitializer extends DefaultServerInitializer {

@@ -38,4 +46,40 @@
        pipeline.addLast("handler", this.getHandler());
    }

    /**
     * 创建支持wss可靠连接的通信。暂时不使用。
     * <pre>
     *     1) 不过目前情况看，一般是在 nginx 端代理设置即可，一般不必在程序中支持
     *     2) 确实需要在程序中支持，需要配置证书，这在集群环境下很难维护。
     * </pre>
     * @param pipeline
     * @param password
     * @throws Exception
     * @date 2024-01-31
     */
    private void createSSLHandler(ChannelPipeline pipeline, String password) throws Exception{
        KeyStore ks = KeyStore.getInstance("JKS");
        InputStream ksInputStream = new FileInputStream("/Users/liukun/ca/demo.liukun.com.keystore.jks");
        ks.load(ksInputStream, password.toCharArray());
        KeyManagerFactory kmf = KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm());
        kmf.init(ks, password.toCharArray());
        SSLContext sslContext = SSLContext.getInstance("TLS");
        sslContext.init(kmf.getKeyManagers(), null, null);
        SSLEngine sslEngine = sslContext.createSSLEngine();
        sslEngine.setUseClientMode(false);
        sslEngine.setNeedClientAuth(false);
        // 需把SslHandler添加在第一位
        pipeline.addFirst("ssl", new SslHandler(sslEngine));
    }

    /**
     * 是否允许使用：wss可靠通道
     * @param enableSSL
     * @date 2024-01-31
     */
    public void setEnableSSL(boolean enableSSL) {
        this.enableSSL = enableSSL;
    }

    private boolean enableSSL = false;
}