https://github.com/automvc/bee
Bee is an AI, easy and high efficiency ORM framework,support JDBC,Cassandra,Mongodb,Sharding,Android,HarmonyOS.
https://github.com/automvc/bee
android-orm dao mongodb-orm orm sharding-jdbc
Last synced: about 2 months ago
JSON representation
Bee is an AI, easy and high efficiency ORM framework,support JDBC,Cassandra,Mongodb,Sharding,Android,HarmonyOS.
- Host: GitHub
- URL: https://github.com/automvc/bee
- Owner: automvc
- License: apache-2.0
- Created: 2018-06-21T14:37:07.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-09-21T15:25:24.000Z (6 months ago)
- Last Synced: 2025-09-21T17:26:53.438Z (6 months ago)
- Topics: android-orm, dao, mongodb-orm, orm, sharding-jdbc
- Language: Java
- Homepage: https://github.com/automvc/bee
- Size: 26.1 MB
- Stars: 627
- Watchers: 23
- Forks: 59
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: Changed_Log.md
- License: LICENSE
Awesome Lists containing this project
- awesome-java - Bee
README
Bee
=========
**Easy for Stronger.**
**Bee** is an ORM framework.
**Bee** is an easy and high efficiency ORM framework.
**Coding Complexity is O(1),it means that Bee will do the Dao for you**.
**You don't need to write the Dao by yourself anymore**.Help you to focus more on the development of business logic.
**Good Feature:** AI, Timesaving/Tasteful, Easy, Automatic (**AiTeaSoft Style**)
## **Good News:**
Newest version is:**Bee V2.5.2 LTS**(just 935k)
1.17.x LTS version:**1.17.25**
Sharding target: It is mainly transparent to business development and coding, with only a little sharding config.
#### [Quick Start:Shardign better example](guide/Quick-start-Sharding.md)
**Bee** see:
https://github.com/automvc/bee
bee-ext:
https://github.com/automvc/bee-ext
Python ORM Bee:
https://github.com/automvc/BeePy
## [中文介绍](../../../bee/blob/master/README_CN.md)
[点击链接可查看中文介绍](../../../bee/blob/master/README_CN.md)
## Requirement
#### Bee jdk1.8+
## Feature & Function:
**Easy to use**:
* 1.Simple interface, convenient to use. The Suid interface provides four object-oriented methods corresponding to the SQL language's select, update, insert, and delete operations.
* 2.By using Bee, you no longer need to write separate DAO code. You can directly call Bee's API to perform operations on the database.
* 3.Convention-over-configuration: Javabean can no annotation, no xml.
* 4.Intelligent automatic filtering of null and empty string properties in entities eliminates the need for writing code to check for non-null values.
* 5.Easily implement partial field queries and native statement pagination.
* 6.Supports returning query results in JSON format; supports chaining.
* 7.Supports Sharding, both database and table Sharding; database-only Sharding; table-only Sharding; and read-write separation. This functionality is transparent to existing code and does not require additional coding.
* 8.Easily extendable with multiple database support (MySQL, MariaDB, Oracle, H2, SQLite, PostgreSQL, SQL Server, Access, Kingbase, Dameng, etc.), and theoretically supports any database supported by JDBC. Additionally, supports Android and Harmony.
* 9.Additional database pagination support for: MsAccess, Cubrid, HSQL, Derby, Firebird, etc.
* 10.Multiple databases can be used simultaneously (e.g., MySQL, Oracle, SQL Server).
**Automatic, powerful**:
* 11.Dynamic/arbitrary combination of query conditions without the need to prepare DAO interfaces in advance. New query requirements can be handled without modifying or adding interfaces.
* 12.Supports transactions, using the same connection for multiple ORM operations, FOR UPDATE, batch processing, executing native SQL statements, and stored procedures.
* 13.Supports object-oriented complex queries, multi-table queries (no N+1 problem), and supports one-to-one, one-to-many, many-to-one, and many-to-many relationships. The result structure can differ based on whether the sub-table uses List;multi-table association update, insert, and delete(2.1.8).
* 14.MongoDB ORM and support for MongoDB Sharding.
* 15.Supports register, interceptor, multi-tenancy, and custom TypeHandlers for handling ResultSet results in queries. SetParaTypeConvert converts PreparedStatement parameter types.
* 16.Custom dynamic SQL tags, such as @in, @toIsNULL1, @toIsNULL2, , . Allows dynamic SQL, converting lists into statements like in (1,2,3) without requiring foreach loops. Batch insertion also does not require foreach.
* 17.Complex query can be automatically parsed by the frontend and backend.
* 18.L1 cache, simple in concept and powerful in function; L1 cache can also be fine tuned like the JVM; Support updatable long-term cache list and update configuration table without restart. Inherently resistant to cache penetration. L2 cache extension support; Redis L2 cache support.
* 19.No third-party plugin dependencies; can be used with zero configuration.
* 20.High performance: close to the speed of JDBC; small file size: Bee V1.17.25 is only 520k, V2.5.2 is only 935k.
**Assist function**:
* 21. Provides a naturally simple solution for generating distributed primary keys: generates globally unique, monotonically increasing (within a worker ID) numeric IDs in a distributed environment.
* 22.Supports automatic generation of Javabean corresponding to tables(support Swagger), creating tables based on Javabean, and automatically generating backend Javaweb code based on templates. Can print executable SQL statements without placeholders for easy debugging. Supports generating SQL scripts in JSON format.
* 23.Supports reading Excel files and importing data into the database; simple operations. Supports generating database tables from Excel configurations.
* 24.Stream tool class StreamUtil;DateUtil date conversion, judge date format, calculate age.
* 25.Rich annotation support: PrimaryKey, Column, Datetime, Createtime, Updatetime; JustFetch, ReplaceInto (MySQL), Dict, DictI18n,GridFs, etc.
* 26.Use entity name _F (automatically generated) to reference entity field names, e.g., Users_F.name or in SuidRichExt interface using the format Users::getName.
## Newest main Function
### **V2.5.2(2025·LTS)**
**2.5.2.1 New Year**
1. MongoDB update,delete,deleteById support for sharding
2. MongoDB modify sharding cache enhance
3. MongoDB index support for sharding
4. add ShardingFullOpTemplate
5. ObjSQLRich(SuidRich) add selectByTemplate for select
**2.5.2.2**
6. fixed bug for MongodbShardingDdlEngine
7. record and print sql execute time
bee.osql.showSqlExecuteTime=true
bee.osql.minSqlExecuteTime=0
8.use CQRS(Command Query Responsibility Segregation) operate database
**2.5.2.6**
9. open some config in Honeyconfig as default
openEntityCanExtend = true
showSQL = true
showShardingSQL = true
showSqlExecuteTime = true
minSqlExecuteTime = 5; //ms
10. column allow use keyword
#there is a switch for it, default is true
bee.osql.naming.allowKeyWordInColumn=true
#define for append if bee do not contain them
bee.osql.naming.sqlKeyWordInColumn
11. separate logger; initialize config independently first
12. BeeSimpleDataSourceBuilder is compatible with different style configurations
### **V2.4.2**
1. GenFiles support genFileViaStream
2. Genbean:update genFieldFile,toString, add method setUpperFieldNameInFieldFile
3. update DoNotSetTabShadngValue tip message(Sharding insert need set the sharding value)
4. SuidRich selectById,deleteById support sharding
5. Condition support clone
6. fixed bug:
sharding select all(no paging)
sharding modify cache
## [Function Detail](../../../bee/blob/master/Changed_Log.md)
[click for: Function Detail](../../../bee/blob/master/Changed_Log.md)
## Bee Support Database list:
1.MySQL
2.Oracle
3.SQL Server
4.MariaDB
5.H2
6.SQLite
7.PostgreSQL
8.MS Access
9.Kingbase
10.DM
11.OceanBase
12.Cubrid,HSQL,Derby,Firebird
13.Other DB that support JDBC
NOSQL:
14.Mongodb
15.ElasticSearch
16.Cassandra
Mobile environment (database):
17.Android
18.Harmony
## ORM Compare
### Compare in JDBC
[ORM-Compare (More Detail)](../../../orm-compare)
Test Evn : Local windows.
DB: MySQL (Version 5.6.24).
Test point: Batch Insert;Paging Select; Transaction(update and select).
Batch Insert(unit: ms)
5k
1w
2w
5w
10w
Bee
529.00
458.33
550.00
1315.67
4056.67
MyBatis
1193
713
1292.67
1824.33
Exception
Paging Select(unit: ms)
20
50
100
200
500
Bee
17.33
58.67
52.33
38.33
57.33
MyBatis
314.33
446.00
1546.00
2294.33
6216.67
Transaction(update and select) (unit: ms)
20
50
100
200
500
Bee
1089.00
70.00
84.00
161.33
31509.33
MyBatis
1144
35
79.67
146.00
32155.33
**Bee need files**
orm\compare\bee\service\BeeOrdersService.java
**MyBatis need files**
orm\compare\mybatis\service\MybatisOrdersService.java
orm\compare\mybatis\dao\OrdersDao.java
orm\compare\mybatis\dao\OrdersMapper.java
orm\compare\mybatis\dao\impl\OrdersDaoImpl.java
common,Javabean and Service interface:
Orders.java
OrdersService.java
### Bee application in App Compare
**Performance comparison data of Bee application in app development**
Operate 10000 records, and the use time comparison is as follows.
Operate 10000 records(unit: ms)
insert
query
delete
greenDao(Android)
104666
600
47
Bee(Android 8.1)
747
184
25
Bee(HarmonyOS P40 Pro simulator)
339
143
2
Quick Start:
=========
## 1. Add Bee
#### 1.1 if it is a maven project,add the following dependency
```xml
org.teasoft
bee-all
2.5.2
mysql
mysql-connector-java
5.1.47
runtime
```
Gradle
```xml
implementation group: 'org.teasoft', name: 'bee-all', version: '2.5.2'
//Gradle(Short)
implementation 'org.teasoft:bee-all:2.5.2'
```
#### 1.2 Of course, can download the jar file directly
## 2. Create the database and the table
eg:
Create one database,default name is bee.
Create the tables and init the data by run the [init-data(user-orders)-mysql.sql](../../../bee-exam/blob/master/src/main/resources/init-data(user-orders)-mysql.sql) file(it is mysql sql script).
## 3. Update the database configuration in bee.properties if need
If no the bee.properties file, you can create it by yourself.
\#bee.databaseName=MySQL
bee.db.dbName=MySQL
bee.db.driverName = com.mysql.jdbc.Driver
\#bee.db.url =jdbc:mysql://localhost:3306/bee?characterEncoding=UTF-8
bee.db.url =jdbc:mysql://127.0.0.1:3306/bee?characterEncoding=UTF-8&useSSL=false
bee.db.username = root
bee.db.password =
\#print log
bee.osql.showSQL=true
bee.osql.showSql.showType=true
bee.osql.showSql.showExecutableSql=true
\# since 2.1.7 sqlFormat=true,will format the executable sql
bee.osql.showSql.sqlFormat=false
\#log4j>slf4j>log4j2>androidLog>harmonyLog>systemLogger>fileLogger>noLogging>jdkLog>commonsLog
bee.osql.loggerType=systemLogger
## 4. The Javabean Orders reference as below:
[Orders(Javabean)](../../../bee-exam/blob/master/src/main/java/org/teasoft/exam/bee/osql/entity/Orders.java)
[Auto Genernate Javabean](../../../bee-exam/blob/master/src/main/java/org/teasoft/exam/bee/osql/autogen/GenBeanExam.java)
## 5. Run the following java code
```java
import java.math.BigDecimal;
import java.util.List;
import org.teasoft.bee.osql.BeeException;
import org.teasoft.bee.osql.Suid;
import org.teasoft.honey.osql.core.BeeFactoryHelper;
import org.teasoft.honey.osql.core.Logger;
/**
* @author Kingstar
* @since 1.0
*/
public class SuidExamEN {
public static void main(String[] args) {
try {
Suid suid = BeeFactoryHelper.getSuid();
Orders orders1 = new Orders();//need gen the Javabean
orders1.setId(100001L);
orders1.setName("Bee(ORM Framework)");
List list1 = suid.select(orders1); // 1. select
for (int i = 0; i < list1.size(); i++) {
Logger.info(list1.get(i).toString());
}
//Condition condition=BF.getCondition(); // The SuidRich interface has many methods with the Condition parameter
//condition.op(Orders_F.userid, Op.ge, 0); // userid>=0
//Op supports: =,>,<,>=,<=,!=, Like, in, not in, etc
orders1.setName("Bee(ORM Framework)");
int updateNum = suid.update(orders1); //2. update
Logger.info("update record:" + updateNum);
Orders orders2 = new Orders();
orders2.setUserid("bee");
orders2.setName("Bee(ORM Framework)");
orders2.setTotal(new BigDecimal("91.99"));
orders2.setRemark(""); // empty String test
int insertNum = suid.insert(orders2); // 3. insert
Logger.info("insert record:" + insertNum);
int deleteNum = suid.delete(orders2); // 4. delete
Logger.info("delete record:" + deleteNum);
} catch (BeeException e) {
Logger.error("In SuidExamEN (BeeException):" + e.getMessage());
//e.printStackTrace();
} catch (Exception e) {
Logger.error("In SuidExamEN (Exception):" + e.getMessage());
//e.printStackTrace();
}
}
}
// notice: this is just a simple sample. Bee suport transaction,paging,complicate select,slect json,and so on.
```
## [Quick Start : Bee + Harmony](guide/Quick-start-for-Harmony.md)
## [Quick Start : Bee + Android](guide/Quick-start-for-Android.md)
## Use Bee in Android Environment
### 1.bee.properties
```properties
bee.db.isAndroid=true
bee.db.androidDbName=account.db
bee.db.androidDbVersion=1
bee.osql.loggerType=androidLog
#turn on query result field type conversion, and more types will be supported
bee.osql.openFieldTypeHandler=true
#If you are allowed to delete and update the whole table, you need to remove the comments
#bee.osql.notDeleteWholeRecords=false
#bee.osql.notUpdateWholeRecords=false
```
### 2.implement tables that need to be created and updated when app installation and upgrade
```java
public class YourAppCreateAndUpgrade implements CreateAndUpgrade{
@Override
public void onCreate() {
// You can create tables in an object-oriented way
Ddl.createTable(new Orders(), false);
Ddl.createTable(new TestUser(), false);
}
@Override
public void onUpgrade(int oldVersion, int newVersion) {
if(newVersion==2) {
Ddl.createTable(new LeafAlloc(), true);
Log.i("onUpgrade", "你在没有卸载的情况下，在线更新到版本:"+newVersion);
}
}
}
```
### 3.Register YourAppCreateAndUpgrade and Android context to Bee
Configure android:name to BeeApplication in AndroidManifest.xml file.
```java
package com.aiteasoft.util;
import org.teasoft.bee.android.CreateAndUpgradeRegistry;
import org.teasoft.beex.android.ApplicationRegistry;
public class BeeApplication extends Application {
private static Context context;
@Override
public void onCreate() {
ApplicationRegistry.register(this);//注册上下文
CreateAndUpgradeRegistry.register(YourAppCreateAndUpgrade.class);
}
}
// 并在AndroidManifest.xml,配置android:name为BeeApplication
```
### 4.Java operation SQLite database is similar to JavaWeb
```java
Suid suid=BF.getSuid();
List list = suid.select(new Orders());
```
### 5.Bee application in App Compare
**Performance comparison data of Bee application in app development**
Operate 10000 records, and the use time comparison is as follows.
Operate 10000 records(unit: ms)
insert
query
delete
greenDao(Android)
104666
600
47
Bee(Android 8.1)
747
184
25
Bee(HarmonyOS P40 Pro simulator)
339
143
2
### [More example/test case](../../../bee-exam/)
### [Bee+Spring-boot Demo](../../../bee-starter-demo/)
## Bee Architecture
**V2.1**
## Bee Common Interface
Rapid application development:
=========
**Let Java more quicker programming than php and Rails.**
**Faster development of new combinations for Java Web：**
[Bee+Spring+SpringMVC](../../../../aiteasoft/bee-spring-springmvc)
**Faster development of new combinations for Spring Cloud microservices：**
[Bee + Spring Boot](../../../bee-springboot)
## KmCoding
[Rapid Application Code Generation Platform](http://www.kmcoding.com)--AiTea Soft made in China!
[Generate code automatically](../../../gencode)
...
App Demo:
=========
### **HarmonyOS application Demo with ORM Bee：**
[Bee + HarmonyOS](../../../../aiteasoft/HarmonyOS-ORM-Bee-Demo)
[Bee + Android](guide/Quick-start-for-Android.md)
Other Document:
=========
### API-DOC
API-V1.17.x(Newest) SourceCode contain bee-1.17 CN & EN API,bee-1.17 CN SourceCode
API-V2.x(Newest) bee-2.5.2 EN API
[wiki Document](../../../bee/wikis)
[CSDN: ORM Bee Document](https://blog.csdn.net/abckingaa/article/details/121664398)
Contact & Welcome:
=========
#### Author's email: honeysoft@126.com
#### If you have any problem on bee, please let me know kindly! Thank you, so much!
#### ORM QQ Group: 992650213 WeChat:AiTeaSoft
#### At the same time, welcome you to join Bee team create a better future.