CN113282277A

CN113282277A - Java服务端开发框架

Info

Publication number: CN113282277A
Application number: CN202110531447.1A
Authority: CN
Inventors: 何志超
Original assignee: Guangzhou Zijing Internet Technology Co ltd
Current assignee: Guangzhou Zijing Internet Technology Co ltd
Priority date: 2021-05-17
Filing date: 2021-05-17
Publication date: 2021-08-20

Abstract

本发明提供了一种JAVA服务端开发框架，以开源的SpringFramework为基础，集成NettyWeb容器，包括Model数据实体层、Repository数据加工层、Service业务逻辑层、Router路由层、Attachment文件处理、Document文档处理、Properties配置管理、Logback日志系统、SQLParser解析器、LonganCore核心处理层；所述Model数据实体层、Repository数据加工层、Service业务逻辑层、Router路由层依次交互数据；所述Attachment文件处理、Document文档处理、Properties配置管理、Logback日志系统、SQLParser解析器、LonganCore核心处理层为独立的功能模块。本发明采用更少的配置代码，更专注业务代码，更完善的文档能力，更灵活便捷的持久层能，更快速的部署能力。

Description

JAVA服务端开发框架

技术领域

本发明涉及计算机应用技术领域，特别是涉及一种JAVA服务端开发框架。

背景技术

随着互联网应用和数字化发展的深入，软件开发技术服务深入工作与生活，全国1.2亿中小微企业触网率不超过10％，绝大部分企业没有IT部门，组织独立的IT团队进行技术数字化改革成本和风险巨大，从成本、专业、质量、服务多维度考虑选择外包公司，是企业必然选择。

在互联网+浪潮下，各行各业都结合自身需求开展数字化建设，其软件开发需求是跟随者市场和用户各行各异、千变万化。尤其中小微企业，对软件建设成本和速度的要求，是对传统软件外包企业的巨大挑战。

传统国外引进的软件开发框架是面向企业级应用，是企业传统信息化时代的产物，在中国互联网业务自由丰富的场景下，软件开发产能受到制约。所以有必要提出一种更容易上手、更好维护的开发框架。

发明内容

针对现有技术中存在的缺陷，本发明的目的在于提供一种JAVA服务端开发框架，具有更少的配置代码，更专注业务代码，更完善的文档能力，更灵活便捷的持久层能，更快速的部署能力。

为了达到上述目的，本发明所采用的具体技术方案如下：

一种JAVA服务端开发框架，以开源的Spring Framework为基础，集成Netty Web容器，包括Model数据实体层、Repository数据加工层、Service业务逻辑层、Router路由层、Attachment文件处理、Document文档处理、Properties配置管理、Logback日志系统、SQLParser解析器、Longan Core核心处理层；所述Model数据实体层、Repository数据加工层、Service业务逻辑层、Router路由层依次交互数据；所述Attachment文件处理、Document文档处理、Properties配置管理、Logback日志系统、SQL Parser解析器、Longan Core核心处理层为独立的功能模块。

优选的，所述JAVA服务端开发框架采用Gradle管理项目代码，数据库支持PostgreSQL、MySQL、MariaBD和/或Oracle。

优选的，所述JAVA服务端开发框架用于供一键部署应用到Netty Web容器，并启动应用，启动应用具体指的是运行Application.Java启动后接口文档的地址为访问域名或者ip+/doc。

优选的，所述Model数据实体层用于定义Model数据包的各项参数，包括自动创建数据库表、表的名称、是否禁止在数据库创建字段和持久化、设定是否序列化到Json中、生成接口文档、标明model与该字段model的关系。

优选的，所述Model数据实体层还用于设定是否指定主键。

优选的，所述Repository数据加工层用于通过方法名称的关键字定义查询方法，将查询方法转化成sql查询语句执行，并处理异常；还用于通过@Query支持原生SQL语句，并支持动态传参。

优选的，所述Repository数据加工层通过find、delete、count方法，配合使用以下关键字命名：And、Or、Is、Between、LessThan、LessThanEqual、GreaterThan、GreaterThanEqual、After、Before、IsNull、IsNotNull、Like、NotLike、OrderBy、True、False。

优选的，所述Service业务逻辑层用于定义Service包，定义内容包括是否提供RPC服务、注入依赖的对象、RPC接口方法、生成文档使用、请求接口参数、传入的字段、指定返回属性。

优选的，还包括自动化生成单元测试接口。

本发明的有益效果在于：更少的配置代码，更专注业务代码，更完善的文档能力，更灵活便捷的持久层能，更快速的部署能力。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1是本发明JAVA服务端开发框架的架构框图。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的其他实施例，都属于本发明保护的范围。

在本发明的描述中，需要说明的是，术语“竖直”、“上”、“下”、“水平”等指示的方位或位置关系为基于附图所示的方位或位置关系，仅是为了便于描述本发明和简化描述，而不是指示或暗示所指的装置或元件必须具有特定的方位、以特定的方位构造和操作，因此不能理解为对本发明的限制。

在本发明的描述中，还需要说明的是，除非另有明确的规定和限定，术语“设置”、“安装”、“相连”、“连接”应做广义理解，例如，可以是固定连接，也可以是可拆卸连接，或一体地连接；可以是机械连接，也可以是电连接；可以是直接相连，也可以通过中间媒介间接相连，可以是两个元件内部的连通。对于本领域的普通技术人员而言，可以根据具体情况理解上述术语在本发明中的具体含义。

如图1所示，本发明提出了一种JAVA服务端开发框架，自定义名称为LonganFramework，以开源的Spring Framework为基础，集成Netty Web容器，包括Model数据实体层、Repository数据加工层、Service业务逻辑层、Router路由层、Attachment文件处理、Document文档处理、Properties配置管理、Logback日志系统、SQL Parser解析器、LonganCore核心处理层；Model数据实体层、Repository数据加工层、Service业务逻辑层、Router路由层依次交互数据；Attachment文件处理、Document文档处理、Properties配置管理、Logback日志系统、SQLParser解析器、Longan Core核心处理层为独立的功能模块。

JAVA服务端开发框架采用Gradle管理项目代码，数据库支持PostgreSQL、MySQL、MariaBD和/或Oracle。JAVA服务端开发框架用于供一键部署应用到Netty Web容器，并启动应用，启动应用具体指的是运行Application.Java启动后接口文档的地址为访问域名或者ip+/doc。

Longan Framework集成了Netty框架，并实现了HTTP服务器，程序员可以一键部署应用到web容器中，并启动。Longan Framework基于Spring和Netty二次封装，默认采用Gradle管理项目代码，数据库支持PostgreSQL、MySQL、MariaBD，Oracle。

运行Application.Java启动后接口文档的地址为访问域名或者ip+/doc，即可启动应用

application properties

开发环境中的配置文件,该配置文件不会打包的jar文件中。

datasource.url＝jdbc:postgresql://localhost:5432/smarttabl

datasource username＝smarttable

datasource password＝qdpaurqk

redis database＝0

redis host＝localhost

redis port＝6379

s password＝redis

erverport＝8080

server.show-sql＝true

attachment type＝jpg,png,pdf

attachment.home＝/home/appuser/attachment

Model数据实体层用于定义Model数据包的各项参数，包括自动创建数据库表、表的名称、是否禁止在数据库创建字段和持久化、设定是否序列化到Json中、生成接口文档、标明model与该字段model的关系。Model数据实体层还用于设定是否指定主键。

@Entity标注实体，自动创建数据库表；

@Table数据库中对应的表的名称；

@Id主键，指定主键，非必须，autoIncrement指定是否采用自增长ID。如果不标注@Id，框架会自动默认把名字id的成员变量设定为主键。

@Transient禁止在数据库创建字段和持久化。

@Json设定是否序列化到Json中。

@Column生成接口文档使用，alias：别名；length:标注该字段至少为几个字符，框架会做判断；sample：例子；description：字段说明；

@OneToMany标明model与该字段model为一对多的关系；

@ManyToMany标明model与该字段model为多对多的关系，框架会自动生成关联表，标明通常为两个model名+link，例如：user_region_link。

举例如下：

@Entity(alias＝"用户")

@Qtable(name＝"users")

public class User{

public final static String GENDER MALE＝"男"；

public final static String GENDER FEMALE＝"女"；

@Id(auto＝false)

private Long id；

@Column((a1ias＝"是否启用",nul1able＝false,sample＝"true")

private Boolean enabled；

@Column(alias＝"是否已认证为主播",nullable＝false,sample＝"true")

private Boolean verified；

@Column(alias＝"手机号",nullable＝false,sample＝"13612447777")

private Stringphone；

@Column(alias＝"昵称",nullable＝false,sample＝"昵称")

Repository数据加工层用于通过方法名称的关键字定义查询方法，将查询方法转化成sql查询语句执行，并处理异常；还用于通过@Query支持原生SQL语句，并支持动态传参。

在Spring中有Repository的概念，repository原意指的是仓库，即数据仓库的意思。Repository居于业务层和数据层之间，将两者隔离开来，在它的内部封装了数据查询和存储的逻辑。

通过方法名称的关键字，即可定义查询方法，不需要查询方法实现的编码，支持的find,delete,count方法，并同时配合使用以下关键字命名：And、Or、Is、Between、LessThan、LessThanEqual、GreaterThan、GreaterThanEqual、After、Before、IsNull、IsNotNull、Like、NotLike、OrderBy、True、False等即可完成查询。框架会对这些方法转化成sql查询语句执行，并处理查询空值等异常。通过@Query可以支持原生SQL语句，并支持动态传参。程序员只需要关注业务，通过自然语言的表达就能完成查询工作。

关键字定义如下表所示：

代码举例如下：

public interface Crudrepository<T,ID>{

T get(ID id)

Optional<T>findbyid(IDid)

Optional>sindone(Examplet>example

Listt>findallo；List<T>findall(Pageable pageable)

List<T>findall(Examplet>example)；

List<T>findall(Example<T>example,Pageable pageable)；

List<T>findallbyid(List<ID>idlist)；

long count()

long count(Examplet>example),

boolean exists(Example<T>example)

boolean existsbyid(ID id),

T save(T entity)i

List<T>saveall(List<T>entitylist)；

voidupdate(T entity)；

Listt>updateall(List<T>entitylist；

Service业务逻辑层用于定义Service包，定义内容包括是否提供RPC服务、注入依赖的对象、RPC接口方法、生成文档使用、请求接口参数、传入的字段、指定返回属性。

Service业务逻辑层采用丰富的标注和关键词简化的编码量，让程序员更加关注业务逻辑。

@RpcService标明这个service可以提供RPC服务。

@Resource注入依赖的对象

@RpcMethod标注具体的RPC接口方法，默认支持事务且readOnly＝false。对于数据查询和统计，需要把readOnly设置为true。

@Request生成文档使用。

@Param为请求接口参数，name为参数的名称，alias为别名，sample为例子,当Param传参为对象时，props为指定对象中需要传入的字段。

@Prop标明传入的字段。

@Response指定返回属性。例如，include＝["id","username"]，返回User的时候，json中只有id和username。默认返回所有非null的属性。filters为控制关联实体中返回的字段，例如：@Filter(type＝TicketOrder.class,includes＝{"id"})，type指定关联的实体，include指定返回字段。

本发明还包括自动化生成单元测试接口，接口测试测试位于test/http目录下，一个model一个测试文件。

本发明具有自动文档功能，运行Application.Java文档系统依照接口注释，更新生成在线文档，启动后接口文档的地址为访问域名或者ip+/doc。

综上所述，本发明Longan Framework是一款优秀的面向微服务的单点应用框架。作为持久层框架，支持定制化SQL、存储过程以及高级映射。Longan Framework避免了几乎所有的JDBC代码和手动设置参数以及获取结果集。Longan Framework可以使用注解来配置和映射原生信息，将接口和Java的POJOs(Plain Ordinary Java Object,普通的Java对象)映射成数据库中的记录。同时，Longan Framework具备完善的自动化文档能力。作为一款国产的开发框架，比myBatis、hibernate更容易上手、更少代码量、更好维护。同时LonganFramework已经具备完全国产化的能力，并依照JPA规范支持了持久层实现。由于考虑到sping框架在国内知名度，在基本数据访问层沿用sping中JPA能力。

本发明的优点在于更少的配置代码，更专注业务代码，更完善的文档能力，更灵活便捷的持久层能，更快速的部署能力。自动化创建数据库表。支持自定义方法调用数据库，减少sql编写；支持插入动态SQL；自动化生产接口文档系统，通过标注生成文档；零配置，持续集成；内嵌服务器，一键部署，快速应用启动。

以上述依据本发明的理想实施例为启示，通过上述的说明内容，本领域技术人员完全可以在不偏离本发明技术思想的范围内，进行多样的变更以及修改。本发明的技术性范围并不局限于说明书上的内容，必须要根据权利要求书范围来确定其技术性范围。

Claims

1.一种JAVA服务端开发框架，其特征在于，以开源的Spring Framework为基础，集成NettyWeb容器，包括Model数据实体层、Repository数据加工层、Service业务逻辑层、Router路由层、Attachment文件处理、Document文档处理、Properties配置管理、Logback日志系统、SQLParser解析器、Longan Core核心处理层；所述Model数据实体层、Repository数据加工层、Service业务逻辑层、Router路由层依次交互数据；所述Attachment文件处理、Document文档处理、Properties配置管理、Logback日志系统、SQLParser解析器、LonganCore核心处理层为独立的功能模块。

2.根据权利要求1所述的JAVA服务端开发框架，其特征在于，所述JAVA服务端开发框架采用Gradle管理项目代码，数据库支持PostgreSQL、MySQL、MariaBD和/或Oracle。

3.根据权利要求1或2所述的JAVA服务端开发框架，其特征在于，所述JAVA服务端开发框架用于供一键部署应用到Netty Web容器，并启动应用，启动应用具体指的是运行Application.Java启动后接口文档的地址为访问域名或者ip+/doc。

4.根据权利要求1所述的JAVA服务端开发框架，其特征在于，所述Model数据实体层用于定义Model数据包的各项参数，包括自动创建数据库表、表的名称、是否禁止在数据库创建字段和持久化、设定是否序列化到Json中、生成接口文档、标明model与该字段model的关系。

5.根据权利要求4所述的JAVA服务端开发框架，其特征在于，所述Model数据实体层还用于设定是否指定主键。

6.根据权利要求1所述的JAVA服务端开发框架，其特征在于，所述Repository数据加工层用于通过方法名称的关键字定义查询方法，将查询方法转化成sql查询语句执行，并处理异常；还用于通过@Query支持原生SQL语句，并支持动态传参。

7.根据权利要求6所述的JAVA服务端开发框架，其特征在于，所述Repository数据加工层通过find、delete、count方法，配合使用以下关键字命名：And、Or、Is、Between、LessThan、LessThanEqual、GreaterThan、GreaterThanEqual、After、Before、IsNull、IsNotNull、Like、NotLike、OrderBy、True、False。

8.根据权利要求1所述的JAVA服务端开发框架，其特征在于，所述Service业务逻辑层用于定义Service包，定义内容包括是否提供RPC服务、注入依赖的对象、RPC接口方法、生成文档使用、请求接口参数、传入的字段、指定返回属性。

9.根据权利要求1所述的JAVA服务端开发框架，其特征在于，还包括自动化生成单元测试接口。