2 Star 4 Fork 2

SINSZM / SZM-SOFA

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
Apache-2.0

SZM-SOFA

一、简介

Szm-Sofa 是开源的基于 Spring Boot 的研发框架,它在 Spring Boot 的基础上,提供了诸如 统一数据响应机制、异常拦截捕获、Swagger文档、分布式文件服务、mybatisPlus集成、Redis缓存工具、基础订单服务、分布式任务等功能和业务能力。在增强了 Spring Boot 的同时,Szm-Sofa 提供了让用户可以在 Spring Boot 中非常方便地使用 SOFA 中间件的能力。

二、应用

2.1.服务列表

清单名称 类型
szm-sofa pom
szm-sofa-boot-starter jar
szm-sofa-boot-starter-dfs jar
szm-sofa-boot-starter-jedis jar
szm-sofa-boot-starter-order jar
szm-sofa-boot-starter-orm jar
szm-sofa-boot-starter-quartz jar
szm-sofa-boot-starter-atomikos jar

2.2.当前版本

com.sinszm.sofa:szm-sofa:pom:1.2.1

com.sinszm.sofa:szm-sofa-boot-starter:jar:1.2.1

com.sinszm.sofa:szm-sofa-boot-starter-dfs:jar:1.2.1

com.sinszm.sofa:szm-sofa-boot-starter-jedis:jar:1.2.1

com.sinszm.sofa:szm-sofa-boot-starter-order:jar:1.2.1

com.sinszm.sofa:szm-sofa-boot-starter-orm:jar:1.2.1

com.sinszm.sofa:szm-sofa-boot-starter-quartz:jar:1.2.1

com.sinszm.sofa:szm-sofa-boot-starter-atomikos:jar:1.2.1

2.3.更新日志

更新日期(2021年12月20日):

1.优化插件版本;

2.修复log4j漏洞;

3.新增多数据源组件;

更新日期(2021年7月23日):

1.提升Hutool工具版本;

2.新增本地部署HDFS文件上传支持;

更新日期(2021年7月2日):

1.将jedis支持更换为redisson支持,并优化默认的工具调用方法;

2.新增订阅与发布工具;

3.提升Hutool工具版本;

4.新增QJob注解和扫描Job包支持,用于可自动创建定时任务;

三、使用说明(以maven方式列举)

3.1.引用方式

在maven的依赖管理器中引入pom依赖,示例如下:

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.sinszm.sofa</groupId>
                <artifactId>szm-sofa</artifactId>
                <version>1.2.1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

3.2.公共组件(szm-sofa-boot-starter)使用说明

依赖引入:

    <dependencies>
        <dependency>
            <groupId>com.sinszm.sofa</groupId>
            <artifactId>szm-sofa-boot-starter</artifactId>
        </dependency>
    </dependencies>

配置推荐(默认yml格式,其他格式自行处理):

logging:
  path: ./logs
  level:
    xxx:
      xxx:
        xxx: debug  #xxx表示你的项目包名
  file:
    path: ${logging.path}


#开启接口文档(文档开关,接口文档访问地址:http://localhost:8080/doc.html)
swagger:
  enable: true


#应用名称必须要,其他配置仅供参考
spring:
  application:
    name: DEMO
  servlet:
    multipart:
      enabled: true
      max-file-size: 1GB
      max-request-size: 1GB
      location: ${user.dir}/tmp
      resolve-lazily: true
  jackson:
    date-format: yyyy-MM-dd HH:mm:ss
    time-zone: GMT+8
    default-property-inclusion: always

推荐异常外抛类:ApiException

推荐统一结果响应工具:ResultUtil

更多工具与使用方式请查看源码及示例代码(后续会补上)。

3.3.文件服务(szm-sofa-boot-starter-dfs)使用说明

依赖引入:

    <dependencies>
        <dependency>
            <groupId>com.sinszm.sofa</groupId>
            <artifactId>szm-sofa-boot-starter-dfs</artifactId>
        </dependency>
    </dependencies>

配置推荐(默认yml格式,其他格式自行处理):

dfs:
  type: minio
  minio:
    endpoint: http://192.168.8.254
    port: 15002
    access-key: 0AKNN7EXAMPLE
    secret-key: 67b8347eed0cc93a83c6b7d5a0cce273
    bucket: demo

更多配置请参考配置类

DfsProperties.java
CosProperties.java
MinIoProperties.java
OssProperties.java

推荐使用注入DfsService接口来实现文件的上传与下载,更多工具可根据实际上传的文件服务器SDK提供情况来调用。

3.4.缓存服务(szm-sofa-boot-starter-jedis)使用说明

依赖引入:

    <dependencies>
        <dependency>
            <groupId>com.sinszm.sofa</groupId>
            <artifactId>szm-sofa-boot-starter-jedis</artifactId>
        </dependency>
    </dependencies>

配置推荐(默认yml格式,其他格式自行处理):

#如果需要使用ObjectRedisTemplate实例和分布式锁功能,推荐使用springBoot自带Redis设置的参数,示例如下:
spring:
  redis:
    url: redis://192.168.8.196:6379
    database: ${jedis.database}
    lettuce:
      pool:
        max-active: 50
        max-idle: 10
        min-idle: 0
        max-wait: -1ms
    timeout: 15000ms

推荐使用工具JedisUtilObjectRedisTemplateLockUtilSubUtil 等来操作缓存、分布式锁、订阅与发布等功能。

3.5.基础订单服务(szm-sofa-boot-starter-order)使用说明

该服务主要用于实现业务订单的基础流程功能,具备内置数据库和指定数据源数据库的表结构还原和数据存储等。

依赖引入:

    <dependencies>
        <dependency>
            <groupId>com.sinszm.sofa</groupId>
            <artifactId>szm-sofa-boot-starter-order</artifactId>
        </dependency>
    </dependencies>

配置推荐(默认yml格式,其他格式自行处理):

order:
  datasource: dataSource
  hibernateDialect: org.hibernate.dialect.MySQL57Dialect

更多配置请参考配置类

SzmOrderProperties.java

推荐使用注入接口OrderApplicationService来处理订单业务及流程。

3.6.数据操作ORM组件(szm-sofa-boot-starter-orm)使用说明

该服务组件主要作用与集成MybatisPlus功能,以及定义了一部分自定义工具方法,主要解决了对新手程序员集成MybatisPlus的复杂性难度。

依赖引入:

    <dependencies>
        <dependency>
            <groupId>com.sinszm.sofa</groupId>
            <artifactId>szm-sofa-boot-starter-orm</artifactId>
        </dependency>
    </dependencies>

配置推荐(默认yml格式,其他格式自行处理):

spring:
  datasource:
    platform: mysql
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://192.168.2.193:3306/dev?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2b8&useSSL=false&allowMultiQueries=true
    username: root
    password: root

orm:
  base-package: com.demo.szm.mapper
  
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

更多配置请参考MybatisPlus官网参数和SpringData的配置参数。

3.7.分布式任务调度组件(szm-sofa-boot-starter-quartz)使用说明

依赖引入:

    <dependencies>
        <dependency>
            <groupId>com.sinszm.sofa</groupId>
            <artifactId>szm-sofa-boot-starter-quartz</artifactId>
        </dependency>
    </dependencies>

配置推荐(默认yml格式,其他格式自行处理):

quartz:
  data-source: dataSource
  mode: always #根据需求指定模式,默认可不填
  instance-name: quartzScheduler #根据需求制定任务实例名称,默认可不填
  scan-task: true #是否启用初始化扫描
  base-packages: com.gftech.nsp.jobs  #job存储包
  base-packages-classes: com.gftech.nsp.jobs.DemoJob #实现了job的对象类

任务调度接口 IQuartzService 可业务中注入该接口进行操作。

任务注解 QJob ,用于设定到类上绑定自动创建任务。

3.8.多数据源组件(szm-sofa-boot-starter-atomikos)使用说明

依赖引入:

    <dependencies>
        <dependency>
            <groupId>com.sinszm.sofa</groupId>
            <artifactId>szm-sofa-boot-starter-atomikos</artifactId>
        </dependency>
        <!-- 数据库驱动根据业务库而定 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
    </dependencies>

配置推荐(默认yml格式,默认第一个数据库连接会有依赖包自动装配,其他格式自行处理):

sofa:
  atomikos:
    db:
      mysql01:
        driverClassName: 'com.mysql.cj.jdbc.Driver'
        url: 'jdbc:mysql://192.168.8.196:3306/supervise01?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2b8&useSSL=false&allowMultiQueries=true'
        username: 'root'
        password: 'root'
        mapperLocations: 'classpath:mapper/mysql01/*.xml'
      mysql02:
        driverClassName: 'com.mysql.cj.jdbc.Driver'
        url: 'jdbc:mysql://192.168.8.196:3306/supervise02?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2b8&useSSL=false&allowMultiQueries=true'
        username: 'root'
        password: 'root'
        mapperLocations: 'classpath:mapper/mysql02/*.xml'

使用示例(非第一个数据源需要自行继承AbstractSqlSessionConfiguration类进行实现如下代码,@MapperScan需要自行添加配置和绑定sqlSessionTemplateRef):

@Configuration
@DependsOn("dataSourceUtil")
@MapperScans({
        @MapperScan(sqlSessionTemplateRef = "sqlSessionTemplate",basePackages = "com.gf.ms.dao.mysql01"),
        @MapperScan(sqlSessionTemplateRef = "mysql02SqlSessionTemplate",basePackages = "com.gf.ms.dao.mysql02")
})
public class TestConfiguration {

    @Configuration
    public static class Mysql02SqlSessionConfiguration extends AbstractSqlSessionConfiguration {

        public Mysql02SqlSessionConfiguration(DataSourceUtil dataSourceUtil) {
            super(dataSourceUtil);
        }

        @Bean(name = "mysql02DataSource")
        @Override
        public AtomikosDataSourceBean dataSource() {
            return super.dataSourceUtil.getDataSource("mysql02");
        }

        @Bean(name = "mysql02SqlSessionFactory")
        @DependsOn("mysql02DataSource")
        @Override
        public SqlSessionFactory sqlSessionFactory() throws Exception {
            return super.getSqlSessionFactory("mysql02DataSource");
        }

        @Bean(name = "mysql02SqlSessionTemplate")
        @DependsOn("mysql02SqlSessionFactory")
        @Override
        public SqlSessionTemplate sqlSessionTemplate() {
            return super.getSqlSessionTemplate("mysql02SqlSessionFactory");
        }
    }

}

四、联系方式

电子邮箱:chenjianbo@sinszm.com

五、参与贡献

Fork 本仓库

新建 Feat_xxx 分支

提交代码

新建 Pull Request

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

快速构建基于SpringBoot的微服务及相关服务生态 Copyright © 2021 sinsz.com All rights reserved. https://www.sinsz.com expand collapse
Java and 3 more languages
Apache-2.0
Cancel

Releases (3)

All

Contributors

All

Activities

Load More
can not load any more
Java
1
https://gitee.com/sinszm/szm-sofa.git
git@gitee.com:sinszm/szm-sofa.git
sinszm
szm-sofa
SZM-SOFA
develop

Search