From 8c51d155cd1aeeec0c31028483e5e1b0769e8e25 Mon Sep 17 00:00:00 2001 From: blinkfox Date: Fri, 11 Oct 2019 01:03:20 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E7=89=88=E6=9C=AC=E5=8F=B7?= =?UTF-8?q?=E4=B8=BA=20v1.1.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 11 ++++++----- docs/README.md | 2 +- docs/_coverpage.md | 2 +- pom.xml | 2 +- src/main/java/com/blinkfox/fenix/bean/SqlInfo.java | 3 ++- 5 files changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a9b04f9..f38efe1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Fenix -[![Build Status](https://secure.travis-ci.org/blinkfox/fenix.svg)](https://travis-ci.org/blinkfox/fenix) [![HitCount](http://hits.dwyl.io/blinkfox/fenix.svg)](http://hits.dwyl.io/blinkfox/fenix) [![Javadocs](http://www.javadoc.io/badge/com.blinkfox/fenix.svg)](http://www.javadoc.io/doc/com.blinkfox/fenix) [![GitHub license](https://img.shields.io/github/license/blinkfox/fenix.svg)](https://github.com/blinkfox/fenix/blob/develop/LICENSE) [![fenix](https://img.shields.io/badge/fenix-v1.0.1-blue)](https://search.maven.org/artifact/com.blinkfox/fenix/1.0.1/jar) [![fenix starter](https://img.shields.io/badge/fenix%20spring%20boot%20starter-v1.0.1-blue)](https://search.maven.org/artifact/com.blinkfox/fenix-spring-boot-starter/1.0.1/jar) [![codecov](https://codecov.io/gh/blinkfox/fenix/branch/develop/graph/badge.svg)](https://codecov.io/gh/blinkfox/fenix) +[![Build Status](https://secure.travis-ci.org/blinkfox/fenix.svg)](https://travis-ci.org/blinkfox/fenix) [![HitCount](http://hits.dwyl.io/blinkfox/fenix.svg)](http://hits.dwyl.io/blinkfox/fenix) [![Javadocs](http://www.javadoc.io/badge/com.blinkfox/fenix.svg)](http://www.javadoc.io/doc/com.blinkfox/fenix) [![GitHub license](https://img.shields.io/github/license/blinkfox/fenix.svg)](https://github.com/blinkfox/fenix/blob/develop/LICENSE) [![fenix](https://img.shields.io/badge/fenix-v1.1.0-blue)](https://search.maven.org/artifact/com.blinkfox/fenix/1.1.0/jar) [![fenix starter](https://img.shields.io/badge/fenix%20spring%20boot%20starter-v1.1.0-blue)](https://search.maven.org/artifact/com.blinkfox/fenix-spring-boot-starter/1.1.0/jar) [![codecov](https://codecov.io/gh/blinkfox/fenix/branch/develop/graph/badge.svg)](https://codecov.io/gh/blinkfox/fenix) > [Fenix](https://github.com/blinkfox/fenix)（菲尼克斯）是一个为了解决复杂动态 SQL (`JPQL`) 而生的 `Spring Data JPA` 扩展库，目的是辅助开发者更方便快捷的书写复杂、动态且易于维护的 SQL，支持 `XML` 和 Java 链式 `API` 两种方式来书写动态 SQL。 @@ -8,12 +8,13 @@ ## 特性 -- 简单、轻量级、无副作用的集成和使用； -- 作为 JPA 的扩展和增强，兼容 Spring Data JPA 的各种特性； +- 简单、轻量级、无副作用的集成和使用，jar 包仅 `86 KB`； +- 作为 JPA 的扩展和增强，兼容 Spring Data JPA 原有功能和各种特性； - 提供了 `XML` 和纯 Java API 两种方式来书写 SQL； - `XML` 的方式功能强大，让 SQL 和 Java 代码解耦，易于维护； - 也可以采用 Java 链式 `API` 来书写动态 SQL； - 具有动态性、极致的可复用性和可调试性的优点； +- SQL 执行结果可返回任意自定义的实体对象，比使用 JPA 自身的投影方式更加简单和自然； - 具有可扩展性，可自定义 `XML` 语义标签和对应的标签处理器来生成自定义逻辑的 SQL 片段和参数； ## 支持场景 @@ -34,14 +35,14 @@ com.blinkfox fenix-spring-boot-starter - 1.0.1 + 1.1.0 ``` ### Gradle ```bash -compile 'com.blinkfox:fenix-spring-boot-starter:1.0.1' +compile 'com.blinkfox:fenix-spring-boot-starter:1.1.0' ``` ### 激活 Fenix FactoryBean diff --git a/docs/README.md b/docs/README.md index e5f6ff6..6cced3a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ ## 特性 -- 简单、轻量级、无副作用的集成和使用，jar 包仅 `84 KB`； +- 简单、轻量级、无副作用的集成和使用，jar 包仅 `86 KB`； - 作为 JPA 的扩展和增强，兼容 Spring Data JPA 原有功能和各种特性； - 提供了 `XML` 和纯 Java API 两种方式来书写 SQL； - `XML` 的方式功能强大，让 SQL 和 Java 代码解耦，易于维护； diff --git a/docs/_coverpage.md b/docs/_coverpage.md index dbf5355..ab7ed7c 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -4,7 +4,7 @@ > 为解决复杂动态 SQL 而生的 Spring Data JPA 扩展库 -- 简单、可扩展、轻量级 (~84 KB jar) +- 简单、可扩展、轻量级 (~86 KB jar) - 可返回任意自定义的实体对象 - 比 MyBatis 更加强大的动态 SQL 能力 - 支持 XML 文件和 Java 链式 API 两种方式书写 SQL diff --git a/pom.xml b/pom.xml index 1909311..afb4293 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ com.blinkfox fenix - 1.1.0-SNAPSHOT + 1.1.0 jar fenix diff --git a/src/main/java/com/blinkfox/fenix/bean/SqlInfo.java b/src/main/java/com/blinkfox/fenix/bean/SqlInfo.java index a4961e1..fcb7f3b 100644 --- a/src/main/java/com/blinkfox/fenix/bean/SqlInfo.java +++ b/src/main/java/com/blinkfox/fenix/bean/SqlInfo.java @@ -51,7 +51,7 @@ public SqlInfo() { * 注意该方法不会移除其对应的参数，所以，这里只应该移除静态 SQL 字符串，不应该移除包含命名参数占位符的 SQL. * * @param subSql 静态子 SQL 片段 - * @return SqlInfo实例 + * @return {@code SqlInfo} 实例 */ public SqlInfo removeIfExist(String subSql) { this.sql = subSql != null && sql.contains(subSql) ? sql.replaceAll(subSql, "") : sql; @@ -62,6 +62,7 @@ public SqlInfo removeIfExist(String subSql) { * 设置查询的自定义返回结果类型的 class，这里主要是指实体 Bean 类的 class 实例. * * @param resultTypeClass 实体 Bean 类的 class 实例 + * @return {@code SqlInfo} 实例 * @since v1.1.0 */ public SqlInfo setResultTypeClass(Class resultTypeClass) {