Skip to content

Commit

Permalink
修改文档,准备发布 2.7.0 正式版本
Browse files Browse the repository at this point in the history
  • Loading branch information
blinkfox committed Mar 31, 2022
1 parent 4a66fc6 commit 56a2d2e
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 7 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[![Build Status](https://secure.travis-ci.org/blinkfox/fenix.svg)](https://travis-ci.org/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-v2.6.1-blue)](https://search.maven.org/artifact/com.blinkfox/fenix/2.6.1/jar) [![fenix starter](https://img.shields.io/badge/fenix%20spring%20boot%20starter-v2.6.1-blue)](https://search.maven.org/artifact/com.blinkfox/fenix-spring-boot-starter/2.6.1/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,支持 ActiveRecord 模式和多种查询方式的写法
> [🔥 Fenix](https://github.com/blinkfox/fenix)(菲尼克斯)是一个为了解决复杂动态 SQL (`JPQL`) 而生的 `Spring Data JPA` 扩展库,能辅助开发者更方便快捷的书写复杂、动态且易于维护的 SQL,支持 ActiveRecord 模式和多种查询方式
[📖 使用文档](https://blinkfox.github.io/fenix) | [✨ Intellij lIDEA 插件](https://plugins.jetbrains.com/plugin/17158-fenix) | [🍉 示例项目 (fenix-example)](https://github.com/blinkfox/fenix-example)

Expand All @@ -24,7 +24,7 @@

## 🏖️️ 二、支持场景

适用于 Java `Spring Data JPA` 项目,`JDK 1.8` 及以上,Spring Data JPA 的版本须保证 `2.1.8.RELEASE` 及以上;如果你是 Spring Boot 项目,则 Spring Boot 的版本须保证 `2.1.5.RELEASE` 及以上。因为后续版本的 Spring Data JPA 对其中 `QueryLookupStrategy` 的代码有较大改动
适用于 Java `Spring Data JPA` 项目,`JDK 8` 及以上,Spring Data JPA 的版本须保证 `2.1.8.RELEASE` 及以上;如果你是 Spring Boot 项目,则 Spring Boot 的版本须保证 `2.1.5.RELEASE` 及以上。

## ☘️ 三、Spring Boot 项目集成

Expand Down Expand Up @@ -99,6 +99,8 @@ fenix:
# v2.2.0 版本新增的配置项,表示自定义的继承自 AbstractPredicateHandler 的子类的全路径名
# 可以配置多个值,通常情况下,你也不需要配置这个值.
predicate-handlers:
# v2.7.0 新增的配置项,表示带前缀下划线转换时要移除的自定义前缀,多个值用英文逗号隔开,通常你不用配置这个值.
underscore-transformer-prefix:
```
## 🍔 四、示例概览
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 🍑 简介 :id=introduction

> [🔥 Fenix](https://github.com/blinkfox/fenix)(菲尼克斯)是一个为了解决复杂动态 SQL (`JPQL`) 而生的 `Spring Data JPA` 扩展库,目的是辅助开发者更方便快捷的书写复杂、动态且易于维护的 SQL,支持 ActiveRecord 模式和多种查询方式的写法
> [🔥 Fenix](https://github.com/blinkfox/fenix)(菲尼克斯)是一个为了解决复杂动态 SQL (`JPQL`) 而生的 `Spring Data JPA` 扩展库,能辅助开发者更方便快捷的书写复杂、动态且易于维护的 SQL,支持 ActiveRecord 模式和多种查询方式
[✨ Intellij IDEA 插件](https://plugins.jetbrains.com/plugin/17158-fenix) | [⛱️ 示例项目 (fenix-example)](https://github.com/blinkfox/fenix-example) | [🏝️ Fenix 使用的单元测试](https://github.com/blinkfox/fenix/tree/develop/src/test/java/com/blinkfox/fenix/repository)

Expand Down
4 changes: 3 additions & 1 deletion docs/quick-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,11 @@ fenix:
# 扫描你自定义的 XML 标签处理器的位置,默认为空,可以是包路径,也可以是 Java 或 class 文件的全路径名
# 可以配置多个值,不过一般情况下,你不自定义自己的 XML 标签和处理器的话,不需要配置这个值.
handler-locations:
# v2.2.0 版本新增的配置项,表示自定义的继承自 AbstractPredicateHandler 的子类的全路径名
# v2.2.0 新增的配置项,表示自定义的继承自 AbstractPredicateHandler 的子类的全路径名
# 可以配置多个值,通常情况下,你也不需要配置这个值.
predicate-handlers:
# v2.7.0 新增的配置项,表示带前缀下划线转换时要移除的自定义前缀,多个值用英文逗号隔开,通常你不用配置这个值.
underscore-transformer-prefix:
```
## 🍁 三、非 SpringBoot 项目集成 :id=not-spring-boot-project
Expand Down
6 changes: 3 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

<name>fenix</name>
<description>This is an extension library to the Spring Data JPA complex or dynamic SQL query.
这是 Spring Data JPA 复杂或动态 SQL 查询的扩展库
这是一个为了解决复杂动态 SQL (JPQL) 而生的 Spring Data JPA 扩展库,能辅助开发者更方便快捷的书写复杂、动态且易于维护的 SQL,支持 ActiveRecord 模式和多种查询方式
</description>
<url>https://github.com/blinkfox/fenix</url>

Expand Down Expand Up @@ -69,7 +69,7 @@
</dependency>

<!-- 由于下面两个依赖在 Spring Data JPA 的 2.6.0 版本中被移除了,但 fenix 使用到了这两个。
因此,在 Fenix 的 2.6.0 版本中添加了这两个依赖项。 -->
为了保持向前兼容,在 Fenix 的 2.6.0 版本中添加了这两个依赖项,后续 3.0 大版本时才会考虑是否移除-->
<dependency>
<groupId>org.dom4j</groupId>
<artifactId>dom4j</artifactId>
Expand Down Expand Up @@ -121,7 +121,7 @@
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.79</version>
<version>1.2.80</version>
<scope>test</scope>
</dependency>
<dependency>
Expand Down

0 comments on commit 56a2d2e

Please sign in to comment.