知识库

使用说明
    为了方便与应用快速集成，aams的使用方式共有两种，第一种是只需导入单个jar，该jar是包含了aams和starter相关的jar，
另一种是按模块导入jar的方式，可将aams、starter分模块导入，产品包提供了各版本的starter以及可选的模块，下面分别介绍这两种使用方式。
1、导入单个jar方式
springboot1.x版本:
    mvn install:install-file -Dfile=aams-spring-boot-starter-all-1.5.20.RELEASE.jar -DgroupId=com.apusic -DartifactId=aams-spring-boot-starter-all -Dversion=1.5.20.RELEASE -Dpackaging=jar
springboot2.0~springboot2.3x版本:
    mvn install:install-file -Dfile=aams-spring-boot-starter-all-2.1.7.RELEASE.jar -DgroupId=com.apusic -DartifactId=aams-spring-boot-starter-all -Dversion=2.1.7.RELEASE -Dpackaging=jar
springboot2.4及以上版本:
    mvn install:install-file -Dfile=aams-spring-boot-starter-all-2.4.0.jar -DgroupId=com.apusic -DartifactId=aams-spring-boot-starter-all -Dversion=2.4.0 -Dpackaging=jar

如果要支持国密，需要install国密模块
    mvn install:install-file -Dfile=optional/aas-sm-3.0.jar -DgroupId=com.apusic -DartifactId=aas-sm -Dversion=3.0 -Dpackaging=jar
    应用pom中引用
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>aas-sm</artifactId>
        <version>3.0</version>
    </dependency>
如果需要支持集中授权，需要install集中授权模块
    mvn install:install-file -Dfile=optional/acls-client-1.0.2.jar -DgroupId=com.apusic.ams.embed -DartifactId=acls-client -Dversion=1.0.2 -Dpackaging=jar
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>acls-client</artifactId>
        <version>1.0.2</version>
    </dependency>
应用的pom文件中导入对应的starter，2.4版本参考如下:
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>aams-spring-boot-starter-all</artifactId>
        <version>2.4.0</version>
    </dependency>

应用的pom文件中导入对应的starter，1.5版本参考如下:
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>aams-spring-boot-starter-all</artifactId>
        <version>1.5.20.RELEASE</version>
    </dependency>
应用的pom文件中导入对应的starter，2.1版本参考如下:
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>aams-spring-boot-starter-all</artifactId>
        <version>2.1.7.RELEASE</version>
    </dependency>
导入starter之后，应用的pom.xml需要排除tomcat的starter，参考如下：
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-tomcat</artifactId>
            </exclusion>
        </exclusions>
    </dependency>

2、按模块导入方式
解压产品包后，确保embed-install.xml文件存在，然后进入embed-install.xml文件同一目录执行：mvn initialize -f embed-install.xml
或者执行下面的命令:
    mvn install:install-file -Dfile=aas-embed-core.jar -DgroupId=com.apusic.ams.embed -DartifactId=aas-embed-core -Dversion=10.1 -Dpackaging=jar
    mvn install:install-file -Dfile=aas-embed-el.jar -DgroupId=com.apusic.ams.embed -DartifactId=aas-embed-el -Dversion=10.1 -Dpackaging=jar
    mvn install:install-file -Dfile=aas-embed-websocket.jar -DgroupId=com.apusic.ams.embed -DartifactId=aas-embed-websocket -Dversion=10.1 -Dpackaging=jar
    mvn install:install-file -Dfile=aas-embed-jasper.jar -DgroupId=com.apusic.ams.embed -DartifactId=aas-embed-jasper -Dversion=10.1 -Dpackaging=jar
    mvn install:install-file -Dfile=aas-dbcp.jar -DgroupId=com.apusic.ams.embed -DartifactId=aas-dbcp -Dversion=10.1 -Dpackaging=jar
    mvn install:install-file -Dfile=aas-util.jar -DgroupId=com.apusic.ams.embed -DartifactId=aas-util -Dversion=10.1 -Dpackaging=jar
    mvn install:install-file -Dfile=ecj-4.20.jar -DgroupId=com.apusic.ams.embed -DartifactId=ecj -Dversion=4.20 -Dpackaging=jar
    mvn install:install-file -Dfile=optional/aas-sm-3.0.jar -DgroupId=com.apusic -DartifactId=aas-sm -Dversion=3.0 -Dpackaging=jar
    mvn install:install-file -Dfile=optional/acls-client-1.0.2.jar -DgroupId=com.apusic -DartifactId=acls-client -Dversion=1.0.2 -Dpackaging=jar

其中optional/aas-sm-3.0.jar是支持国密必选模块，optional/acls-client-1.0.2.jar是支持集中授权必选模块
接着需要导入对应版本的starter
# springboot1.x版本:
mvn install:install-file -Dfile=aams-spring-boot-starter-1.5.20.RELEASE.jar -DgroupId=com.apusic -DartifactId=aams-spring-boot-starter -Dversion=1.5.20.RELEASE -Dpackaging=jar -DpomFile=aams-spring-boot-starter.pom.xml
mvn install:install-file -Dfile=aams-spring-boot-websocket-starter-1.5.20.RELEASE.jar -DgroupId=com.apusic -DartifactId=aams-spring-boot-websocket-starter -Dversion=1.5.20.RELEASE -Dpackaging=jar -DpomFile=aams-spring-boot-websocket-starter.pom.xml

# springboot2.0~springboot2.3x版本:
mvn install:install-file -Dfile=aams-spring-boot-starter-2.1.7.RELEASE.jar -DgroupId=com.apusic -DartifactId=aams-spring-boot-starter -Dversion=2.1.7.RELEASE -Dpackaging=jar  -DpomFile=aams-spring-boot-starter.pom.xml
mvn install:install-file -Dfile=aams-spring-boot-websocket-starter-2.1.7.RELEASE.jar -DgroupId=com.apusic -DartifactId=aams-spring-boot-websocket-starter -Dversion=2.1.7.RELEASE -Dpackaging=jar -DpomFile=aams-spring-boot-websocket-starter.pom.xml
mvn install:install-file -Dfile=aams-spring-boot-web-starter-2.1.7.RELEASE.jar -DgroupId=com.apusic -DartifactId=aams-spring-boot-web-starter -Dversion=2.1.7.RELEASE -Dpackaging=jar -DpomFile=aams-spring-boot-web-starter.pom.xml

# springboot2.4及以上版本:
mvn install:install-file -Dfile=aams-spring-boot-starter-2.4.0.jar -DgroupId=com.apusic -DartifactId=aams-spring-boot-starter -Dversion=2.4.0 -Dpackaging=jar -DpomFile=aams-spring-boot-starter.pom.xml
mvn install:install-file -Dfile=aams-spring-boot-websocket-starter-2.4.0.jar -DgroupId=com.apusic -DartifactId=aams-spring-boot-websocket-starter -Dversion=2.4.0 -Dpackaging=jar -DpomFile=aams-spring-boot-websocket-starter.pom.xml
mvn install:install-file -Dfile=aams-spring-boot-web-starter-2.4.0.jar -DgroupId=com.apusic -DartifactId=aams-spring-boot-web-starter -Dversion=2.4.0 -Dpackaging=jar -DpomFile=aams-spring-boot-web-starter.pom.xml

应用的pom文件中导入对应的模块，2.4版本参考如下:
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>aams-spring-boot-starter</artifactId>
        <version>2.4.0</version>
    </dependency>
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>aams-spring-boot-websocket-starter</artifactId>
        <version>2.4.0</version>
    </dependency>
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>aams-spring-boot-web-starter</artifactId>
        <version>2.4.0</version>
    </dependency>

应用的pom文件中导入对应的模块，1.5版本参考如下:
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>aams-spring-boot-starter</artifactId>
        <version>1.5.20.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>aams-spring-boot-websocket-starter</artifactId>
        <version>1.5.20.RELEASE</version>
    </dependency>
应用的pom文件中导入对应的模块，2.1版本参考如下:
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>aams-spring-boot-starter</artifactId>
        <version>2.1.7.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>aams-spring-boot-websocket-starter</artifactId>
        <version>2.1.7.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>aams-spring-boot-web-starter</artifactId>
        <version>2.1.7.RELEASE</version>
    </dependency>
导入starter之后，应用的pom.xml需要排除tomcat的starter，参考如下：
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-tomcat</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
如果要支持国密，需要install国密模块
    mvn install:install-file -Dfile=optional/aas-sm-3.0.jar -DgroupId=com.apusic -DartifactId=aas-sm -Dversion=3.0 -Dpackaging=jar
    应用pom中引用
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>aas-sm</artifactId>
        <version>3.0</version>
    </dependency>
如果需要支持集中授权，需要install集中授权模块
    mvn install:install-file -Dfile=optional/acls-client-1.0.2.jar -DgroupId=com.apusic.ams.embed -DartifactId=acls-client -Dversion=1.0.2 -Dpackaging=jar
    <dependency>
        <groupId>com.apusic</groupId>
        <artifactId>acls-client</artifactId>
        <version>1.0.2</version>
    </dependency>
配置参数说明：
server:
  #use-forward-headers: true          # 是否使用请求转发
  #protocol-header: X-Forwarded-Proto # 请求转发协议的请求头
  #remote-ip-header: X-Forwarded-For  # 转发真实请求IP的请求头
  #port-header: X-Forwarded-Port      # 转发真实请求端口的请求头
  connection-timeout: 60000  # 连接超时时间，可设置大一些
  aas:
    max-threads: 500           # 最大线程数
    min-spare-threads: 64      # 最小空闲数，压测的时候可以设置跟最大线程数一样
    max-http-header-size: 8192 # 最大请求头个数
    max-http-post-size: 8192   # 最大请求体个数
    connection-timeout: 60000  # 连接超时时间，可设置大一些
    max-connections: 50000     # 最大并发数，压测时，可设置
    accept-count: 1024         # 最大并发数，压测时，可设置
    max-swallow-size: 20971520 # 请求body
    compression: true          # 是否启用压缩
    compression-min-size: 4096 # 超过该大小才压缩
    compressable-mime-type: text/html,text/plain,text/css,application/javascript,application/json,application/x-font-ttf,application/x-font-otf,image/svg+xml
    max-keep-alive-timeout: 300000 # keepalive时间
    max-keep-alive-requests: 100    # 限制keepalive时间连接个数，1表示短链接，-1表示不限制
    disable-upload-timeout: true   # 是否禁用上传超时
    relaxed-path-chars: \"<>[\\]^`{|} # 允许特殊字符
    relaxed-query-chars: \"<>[\\]^`{|} # 允许特殊字符
    use-sendfile: true # 是否启用sendfile
    resource:
      allow-caching: false # 是否缓存
      cache-ttl: 6000 # 缓存时长