Skip to content

modify README #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
robinhood-jim merged 1 commit into from
Dec 10, 2024
Merged

modify README #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 35 additions & 26 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,36 @@ Slightly Framework design to support Spring based java or Bigdata program.

I.This project is base on Spring Framework and has below modules:
|----------------------------------------------------------------------------------------------------------------|
| Module | Description |
| Module | Description
|----------------------------------------------------------------------------------------------------------------|
| Core | the core class include data access layer basic class(model,dao,service) and etc. |
|----------------------------------------------------------------------------------------------------------------|
| Comm | FileSystem Access tool(local/vfs),support FileFormat(csv/xml/json/avro/parquet/protobuf)|
| | ,support Compress Format(gzip/bzip2/snappy/lzo/zip/lzma/lz4) |
| | ,read and write excel,read word or PowerPoint |
| Comm | FileSystem Access tool(local/vfs),support FileFormat(csv/xml/json/avro/parquet/protobuf) |
| | ,support Compress Format(gzip/bzip2/snappy/lzo/zip/lzma/lz4) |
| | ,read and write excel,read word or PowerPoint |
|----------------------------------------------------------------------------------------------------------------|
|Hadooptool |FileSystem Access tool(hdfs), comm tool to access to HDFS,Hbase,Hive,Mongdb and etc |
|Hadooptool |FileSystem Access tool(hdfs), comm tool to access to HDFS,Hbase,Hive,Mongdb and etc |
|----------------------------------------------------------------------------------------------------------------|
|Example |springmvc config based and spring boot based Simple framework Example; |
|Example |springmvc config based and spring boot based Simple framework Example; |
|----------------------------------------------------------------------------------------------------------------|
|Web |struts1,struts2 and springmvc support web component and required class. |
|Web |struts1,struts2 and springmvc support web component and required class. |
|----------------------------------------------------------------------------------------------------------------|
|Webui |Spring Boot with Oauth2 Thymeleaf Example; |
|Webui |Spring Boot with Oauth2 Thymeleaf Example; |
|----------------------------------------------------------------------------------------------------------------|
|Estool | ElasticSearch Comm Query tool |
|Estool | ElasticSearch Comm Query tool |
|----------------------------------------------------------------------------------------------------------------|
|Tracer | Zipkin Brave tracing，Can trace All Database and Record parameters |
|Tracer | Zipkin Brave tracing，Can trace All Database and Record parameters |
|----------------------------------------------------------------------------------------------------------------|


It is available under the terms of either the Apache Software License 2.0 or the Eclipse Public License 1.0.

2.Support Features

I. Construct Simple Java FrameWork
contain use sysrole and relation with customer privilege to use and roles;
1.xml based standard frame : see example/config-example
2.spring based standard frame: see example/boot-example
1.xml based standard frame : see example/config-example
2.spring based standard frame: see example/boot-example

II. Bigdata supprot
hadooptool:
Expand All @@ -63,20 +64,27 @@ Slightly Framework design to support Spring based java or Bigdata program.
Amazon S3
Aliyun OSS
Tencent COS
Minio
Qiniu Koda
Apache Kafka
RabbitMq

V. Iterable and wirtable support intergate Storage and file format
mix storage and File format to support cross storage read/write

VI. Spring cloud support
WebUI simple webui base on dhtmlxGrid 5.1 with spring boot native
related project in my another project microservices
WebUI simple webui base on dhtmlxGrid 5.1 with spring boot native
related project in my another project microservices

VII. Zipkin Intergation
trace sub project aimed to support All database to be tracable and can record query parameters.

VIII. Special feature
VIII.Dataming support
Support weka dataming tools
Support simile dataming tools
Support spark mlib dataming tools

IX. Special feature
a.A user defined xml Query config system,similar to mybatis,but easy config.
b.Support defined annotation or jpa annotation in JdbcDao with ORM.
c. BaseAnnotationService can access DB with minimize code,and use transaction with annotation.
Expand All @@ -102,14 +110,14 @@ Slightly Framework design to support Spring based java or Bigdata program.
@MappingEnity
-------------------------------------------------------------------
|parameter |reference |
|table |tableName |
|value |tableName |
|schema |specify schema |
|jdbcDao |Specify JdbcDao(can switch datasource) | |
--------------------------------------------------------------------
@MappingField
----------------------------------------------------------------------------------------
|parameter |reference |
|field |DB column name,if java param same as columnName,can unsign |
|value |DB column name,if java param same as columnName,can unsign |
|primary |if column is primary,set true |
|increment |if column is autoincrement,set true |
|sequenceName |column insert with sequence,set sequenceName |
Expand All @@ -130,15 +138,16 @@ Slightly Framework design to support Spring based java or Bigdata program.
exmaple: core/src/test/java/com/robin/core/test/service
base class:
main function
---------------------------------------------------------------------------------
|function name |description |
|saveEntity |insert to DB |
|updateEntity |update to DB |
|deleteEntity |delete by key array |
|getEntity |select by id |
|queryByField |query with specify column and value |
|queryBySelectId |query with config query |
---------------------------------------------------------------------------------
-------------------------------------------------------------------------
|function name |description |
------------------------------------------------------------------------|
|saveEntity |insert to DB |
|updateEntity |update to DB |
|deleteEntity |delete by key array |
|getEntity |select by id |
|queryByField |query with specify column and value |
|queryBySelectId |query with config query |
------------------------------------------------------------------------

4.Query Configuration XML
4.1 Config Spring Bean
Expand Down
28 changes: 24 additions & 4 deletions README.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Simple Java Frame V1.0
简易支持只定义ORM,可以灵活整合JPA，mybatis_plus,提供大数据相关工具类
简易支持自定义ORM,可以灵活整合JPA，mybatis_plus,提供大数据相关工具类，支持数据挖掘工具
[![Build Status](https://api.travis-ci.com/robinhood-jim/JavaFramework.svg?branch=master)](https://app.travis-ci.com/github/robinhood-jim/JavaFramework)
[![CircleCI](https://circleci.com/gh/robinhood-jim/JavaFramework.svg?style=svg)](https://circleci.com/gh/robinhood-jim/JavaFramework)
![license](https://img.shields.io/badge/license-Apache--2.0-green.svg)
Expand All @@ -10,7 +10,7 @@
#### 软件架构
软件架构说明

目前框架由6个模块组成
目前框架由8个模块组成

1.Core：核心包，包含Model/DAO/Service及ORM的基础类及DB Dialect。数据库Dump和Import的工具包等，支持JAVA基本框架的内容
增加License 管理功能，支持引用核心包后带上许可验证功能
Expand All @@ -19,11 +19,30 @@
4.web：基于SpringMVC的基础类及Spring message的基础类（支持多国语言）
5.metadata 基于统一资源访问的关系数据源与NoSql数据源的元数据数据探索和管理；
6.estool 通用的ElasticSearch查询访问工具类，能自动感知es下的所有索引，基于restapi
7.trace 基于Zipkin的链路追踪项目，支持任意数据库的追踪，并支持记录PreparedStatement 的参数；
8.dataming 数据挖掘工具支持（支持Weka Smile spark mlib 等数据挖掘框架）

Spring Boot 支持

spring-start 工程，与spring boot 进行整合，支持链路追踪相关的配置（基于zipkin），基于探针的链路追踪详见另一个开源工程comm-probe

通用文件系统和云存储读写访问支持

支持本地文件（Local）/HDFS/ApacheVFS 等文件系统
支持 亚马逊 S3/阿里云/腾讯云/百度云/七牛云/Minio 等云存储系统
支持Apache Kafka/rabittMQ 等流式处理平台

大数据通用文件格式读写支持

支持parquet/orc/avro/protobuf/csv/xml/json 等文件格式
与通用文件系统和云存储访问整合，支持压缩格式

数据挖掘平台支持

支持Weka/Smile/spark mlib 数据挖掘工具，与上面提到的文件格式读写和通用文件系统读取能力结合；
支持ARFF格式文件操作 （Weka 支持）


core与common工程由ProGuard进行混淆保护

#### 安装教程
Expand All @@ -49,15 +68,15 @@ core与common工程由ProGuard进行混淆保护
@MappingEnity
-------------------------------------------------------------------
|参数 |说明 |
|table |表名 |
|value |表名 |
|schema |schema |
|jdbcDao |多数据源支持(详见core的testcase) |
--------------------------------------------------------------------
字段标识说明
@MappingField
----------------------------------------------------------------------------------------
|parameter |reference |
|field |数据库字段名，确实驼峰命名 |
|value |数据库字段名，确实驼峰命名 |
|primary |主键设为true |
|increment |自增长设为true |
|sequenceName |支持sequence得数据库设为true |
Expand Down Expand Up @@ -134,6 +153,7 @@ core与common工程由ProGuard进行混淆保护
BaseController Contorller 基类
BaseCrudController 基于单表增删改查
BaseCrudDhtmlxController 结合Dhtmlx 5.1，辅助类
AbstractAutoController 自动装配的Controller，零代码实现CRUD基本操作

V.统一资源访问

Expand Down
Loading