This repository has been archived by the owner on Feb 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #310 from sofastack/youji-dev
optimze plugin
- Loading branch information
Showing
46 changed files
with
1,011 additions
and
35 deletions.
There are no files selected for viewing
2 changes: 1 addition & 1 deletion
2
docs/content/zh-cn/docs/contribution-guidelines/runtime/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| title: 多模块运行时适配 | ||
| title: 多模块运行时适配或最佳实践 | ||
| date: 2023-09-21T10:28:35+08:00 | ||
| weight: 900 | ||
| --- | ||
|
|
||
Binary file added
BIN
+479 KB
...content/zh-cn/docs/contribution-guidelines/runtime/already_exists_exception.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
87 changes: 87 additions & 0 deletions
87
docs/content/zh-cn/docs/contribution-guidelines/runtime/ehcache.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| --- | ||
| title: ehcache 的多模块化最佳实践 | ||
| date: 2023-10-10T20:32:35+08:00 | ||
| weight: 2 | ||
| --- | ||
|
|
||
| ## 为什么需要最佳实践 | ||
| CacheManager 初始化的时候存在共用 static 变量，多应用使用相同的 ehcache name，导致缓存互相覆盖。 | ||
|
|
||
| ## 最佳实践的几个要求 | ||
| 1. 基座里必须引入 ehcache，模块里复用基座 | ||
|
|
||
| 在 springboot 里 ehcache 的初始化需要通过 Spring 里定义的 EhCacheCacheConfiguration 来创建，由于 EhCacheCacheConfiguration 是属于 Spring, Spring 统一放在基座里。 | ||
|  | ||
|
|
||
| 这里在初始化的时候，在做 Bean 初始化的条件判断时会走到类的检验， | ||
|  | ||
| 如果 net.sf.ehcache.CacheManager 是。这里会走到 java native 方法上做判断，从当前类所在的 ClassLoader 里查找 net.sf.ehcache.CacheManager 类，所以基座里必须引入这个依赖，否则会报 ClassNotFound 的错误。 | ||
|  | ||
|
|
||
| 2. 模块里将引入的 ehcache 排包掉（scope设置成 provide，或者使用自动瘦身能力） | ||
|
|
||
| 模块使用自己 引入的 ehcache，照理可以避免共用基座 CacheManager 类里的 static 变量，而导致报错的问题。但是实际测试发现，模块安装的时候，在初始化 enCacheCacheManager 时， | ||
|  | ||
|  | ||
| 这里在 new 对象时，需要先获得对象所属类的 CacheManager 是基座的 CacheManager。这里也不能讲 CacheManager 由模块 compile 引入，否则会出现一个类由多个不同 ClassLoader 引入导致的问题。 | ||
|  | ||
|
|
||
| 所以结论是，这里需要全部委托给基座加载。 | ||
|
|
||
| ## 最佳实践的方式 | ||
| 1. 模块 ehcache 排包瘦身委托给基座加载 | ||
| 2. 如果多个模块里有多个相同的 cacheName，需要修改 cacheName 为不同值。 | ||
| 3. 如果不想改代码的方式修改 cache name，可以通过打包插件的方式动态替换 cacheName | ||
| ```xml | ||
| <plugin> | ||
| <groupId>com.google.code.maven-replacer-plugin</groupId> | ||
| <artifactId>replacer</artifactId> | ||
| <version>1.5.3</version> | ||
| <executions> | ||
| <!-- 打包前进行替换 --> | ||
| <execution> | ||
| <phase>prepare-package</phase> | ||
| <goals> | ||
| <goal>replace</goal> | ||
| </goals> | ||
| </execution> | ||
| </executions> | ||
| <configuration> | ||
| <!-- 自动识别到项目target文件夹 --> | ||
| <basedir>${build.directory}</basedir> | ||
| <!-- 替换的文件所在目录规则 --> | ||
| <includes> | ||
| <include>classes/j2cache/*.properties</include> | ||
| </includes> | ||
| <replacements> | ||
| <replacement> | ||
| <token>ehcache.ehcache.name=f6-cache</token> | ||
| <value>ehcache.ehcache.name=f6-${parent.artifactId}-cache</value> | ||
| </replacement> | ||
|
|
||
| </replacements> | ||
| </configuration> | ||
| </plugin> | ||
| ``` | ||
|
|
||
| 4. 需要把 FactoryBean 的 shared 设置成 false | ||
| ```java | ||
| @Bean | ||
| public EhCacheManagerFactoryBean ehCacheManagerFactoryBean() { | ||
| EhCacheManagerFactoryBean factoryBean = new EhCacheManagerFactoryBean(); | ||
|
|
||
| // 需要把 factoryBean 的 share 属性设置成 false | ||
| factoryBean.setShared(true); | ||
| // factoryBean.setShared(false); | ||
| factoryBean.setCacheManagerName("biz1EhcacheCacheManager"); | ||
| factoryBean.setConfigLocation(new ClassPathResource("ehcache.xml")); | ||
| return factoryBean; | ||
| } | ||
| ``` | ||
| 否则会进入这段逻辑，初始化 CacheManager 的static 变量 instance. 该变量如果有值，且如果模块里 shared 也是ture 的化，就会重新复用 CacheManager 的 instance，从而拿到基座的 CacheManager, 从而报错。 | ||
|  | ||
|  | ||
|
|
||
|
|
||
| ## 最佳实践的样例 | ||
| 样例工程请[参考这里](https://github.com/sofastack/sofa-serverless/tree/master/samples/springboot-samples/cache/ehcache) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+531 KB
...content/zh-cn/docs/contribution-guidelines/runtime/same_cache_manager_check.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+443 KB
...content/zh-cn/docs/contribution-guidelines/runtime/static_cache_manager_map.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
|
|
||
| # 实验内容： 基座、模块使用 Redis | ||
|
|
||
| ## 实验原理 | ||
| 原理[请看这里](https://sofaserverless.gitee.io/docs/contribution-guidelines/runtime/ehcache/) | ||
|
|
||
| ## 实验应用 | ||
| ### base | ||
| base 为普通 springboot 改造成的基座，改造内容为在 pom 里增加如下依赖 | ||
| ```xml | ||
|
|
||
| <!-- 这里添加动态模块相关依赖 --> | ||
| <dependency> | ||
| <groupId>com.alipay.sofa.serverless</groupId> | ||
| <artifactId>sofa-serverless-base-starter</artifactId> | ||
| </dependency> | ||
| <!-- end 动态模块相关依赖 --> | ||
|
|
||
| <!-- 这里添加 tomcat 单 host 模式部署多web应用的依赖 --> | ||
| <dependency> | ||
| <groupId>com.alipay.sofa</groupId> | ||
| <artifactId>web-ark-plugin</artifactId> | ||
| </dependency> | ||
| <!-- end 单 host 部署的依赖 --> | ||
|
|
||
| <!-- 引入 ehcache 依赖 --> | ||
| <dependency> | ||
| <groupId>net.sf.ehcache</groupId> | ||
| <artifactId>ehcache</artifactId> | ||
| </dependency> | ||
|
|
||
| ``` | ||
|
|
||
| ### biz1 | ||
| biz1 是普通 springboot 应用，修改打包插件方式为 sofaArk biz 模块打包方式，打包为 ark biz jar 包，打包插件配置如下： | ||
| ```xml | ||
| <dependency> | ||
| <groupId>net.sf.ehcache</groupId> | ||
| <artifactId>ehcache</artifactId> | ||
| </dependency> | ||
|
|
||
| <!-- 修改打包插件为 sofa-ark biz 打包插件，打包成 ark biz jar --> | ||
| <plugin> | ||
| <groupId>com.alipay.sofa</groupId> | ||
| <artifactId>sofa-ark-maven-plugin</artifactId> | ||
| <version>${sofa.ark.version}</version> | ||
| <executions> | ||
| <execution> | ||
| <id>default-cli</id> | ||
| <goals> | ||
| <goal>repackage</goal> | ||
| </goals> | ||
| </execution> | ||
| </executions> | ||
| <configuration> | ||
| <skipArkExecutable>true</skipArkExecutable> | ||
| <outputDirectory>./target</outputDirectory> | ||
| <bizName>${bizName}</bizName> | ||
| <!-- 单host下需更换 web context path --> | ||
| <webContextPath>${bizName}</webContextPath> | ||
| <declaredMode>true</declaredMode> | ||
| <packExcludesConfig>rules.txt</packExcludesConfig> | ||
| </configuration> | ||
| </plugin> | ||
| ``` | ||
| 注意这里通过引入 rules.txt 来完成模块自动瘦身，其中包括 ehcache 的依赖也会自动委托给基座加载。另外也需将不同 biz 的web context path 修改成不同的值，以此才能成功在一个 tomcat host 里安装多个 web 应用。 | ||
|
|
||
| ### biz2 | ||
| 同 biz1 | ||
|
|
||
|
|
||
| ## 实验任务 | ||
| 1. 执行 mvn clean package -DskipTests | ||
| 2. 启动基座应用 base，确保基座启动成功 | ||
| 3. 执行 curl 命令安装 biz1 和 biz2, 也可以使用 arkctl 安装 | ||
| ```shell | ||
| curl --location --request POST 'localhost:1238/installBiz' \ | ||
| --header 'Content-Type: application/json' \ | ||
| --data '{ | ||
| "bizName": "biz1", | ||
| "bizVersion": "0.0.1-SNAPSHOT", | ||
| // local path should start with file://, alse support remote url which can be downloaded | ||
| "bizUrl": "file:///path/to/springboot-samples/web/tomcat/biz1/target/biz1-ehcache-0.0.1-SNAPSHOT-ark-biz.jar" | ||
| }' | ||
| ``` | ||
|
|
||
| ```shell | ||
| curl --location --request POST 'localhost:1238/installBiz' \ | ||
| --header 'Content-Type: application/json' \ | ||
| --data '{ | ||
| "bizName": "biz2", | ||
| "bizVersion": "0.0.1-SNAPSHOT", | ||
| // local path should start with file://, alse support remote url which can be downloaded | ||
| "bizUrl": "file:///path/to/springboot-samples/samples/web/tomcat/biz2/target/biz2-ehcache-0.0.1-SNAPSHOT-ark-biz.jar" | ||
| }' | ||
| ``` | ||
|
|
||
| 如果想验证热部署，可以通过多次卸载多次部署，然后验证请求是否正常 | ||
| ```shell | ||
| curl --location --request POST 'localhost:1238/uninstallBiz' \ | ||
| --header 'Content-Type: application/json' \ | ||
| --data '{ | ||
| "bizName": "biz1", | ||
| "bizVersion": "0.0.1-SNAPSHOT" | ||
| }' | ||
| ``` | ||
|
|
||
| 4. 发起基座请求验证基座 ehcache 能力是否正常 | ||
| ```shell | ||
| curl -X POST http://localhost:8080/getUserById?id=111 | ||
| ``` | ||
|
|
||
| 返回 `user_base-ehcache_111`, 并在第一次发起请求是能看到日志 | ||
| ```text | ||
| add user into cache: {"id": 111, "value": user_base-ehcache_111} | ||
| ``` | ||
| 后续请求返回 `user_base-ehcache_111`, 但看不到日志，因为已经直接从 ehcache 获取值。 | ||
|
|
||
| 5. 发起基座请求验证基座 ehcache 能力是否正常 | ||
| ```shell | ||
| curl -X POST http://localhost:8080/biz1/getUserById?id=111 | ||
| ``` | ||
|
|
||
| 返回 `user_biz1-ehcache_111`, 并在第一次发起请求是能看到日志 | ||
| ```text | ||
| add user into cache: {"id": 111, "value": user_biz1-ehcache_111} | ||
| ``` | ||
| 后续请求返回 `user_biz1-ehcache_111`, 但看不到日志，因为已经直接从 ehcache 获取值。 | ||
|
|
||
|
|
||
| 6. 发起基座请求验证基座 ehcache 能力是否正常 | ||
| ```shell | ||
| curl -X POST http://localhost:8080/biz2/getUserById?id=111 | ||
| ``` | ||
|
|
||
| 返回 `user_biz2-ehcache_111`, 并在第一次发起请求是能看到日志 | ||
| ```text | ||
| add user into cache: {"id": 111, "value": user_biz2-ehcache_111} | ||
| ``` | ||
| 后续请求返回 `user_biz2-ehcache_111`, 但看不到日志，因为已经直接从 ehcache 获取值。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <parent> | ||
| <groupId>com.alipay.sofa.serverless.cache</groupId> | ||
| <artifactId>ehcache</artifactId> | ||
| <version>0.0.1-SNAPSHOT</version> | ||
| <relativePath>../pom.xml</relativePath> <!-- lookup parent from repository --> | ||
| </parent> | ||
| <artifactId>base-ehcache</artifactId> | ||
| <version>0.0.1-SNAPSHOT</version> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>org.springframework.boot</groupId> | ||
| <artifactId>spring-boot-starter-cache</artifactId> | ||
| </dependency> | ||
|
|
||
| <dependency> | ||
| <groupId>org.springframework.boot</groupId> | ||
| <artifactId>spring-boot-starter-web</artifactId> | ||
| </dependency> | ||
|
|
||
| <dependency> | ||
| <groupId>net.sf.ehcache</groupId> | ||
| <artifactId>ehcache</artifactId> | ||
| </dependency> | ||
|
|
||
| <dependency> | ||
| <groupId>com.alipay.sofa.serverless</groupId> | ||
| <artifactId>sofa-serverless-base-starter</artifactId> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.alipay.sofa</groupId> | ||
| <artifactId>web-ark-plugin</artifactId> | ||
| </dependency> | ||
|
|
||
| <dependency> | ||
| <groupId>org.springframework.boot</groupId> | ||
| <artifactId>spring-boot-starter-test</artifactId> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| </dependencies> | ||
|
|
||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.springframework.boot</groupId> | ||
| <artifactId>spring-boot-maven-plugin</artifactId> | ||
| <configuration> | ||
| <image> | ||
| <builder>paketobuildpacks/builder-jammy-base:latest</builder> | ||
| </image> | ||
| </configuration> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
|
|
||
| </project> |
13 changes: 13 additions & 0 deletions
13
...mples/cache/ehcache/base/src/main/java/com/alipay/sofa/cache/ehcache/BaseApplication.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| package com.alipay.sofa.cache.ehcache; | ||
|
|
||
| import org.springframework.boot.SpringApplication; | ||
| import org.springframework.boot.autoconfigure.SpringBootApplication; | ||
|
|
||
| @SpringBootApplication | ||
| public class BaseApplication { | ||
|
|
||
| public static void main(String[] args) { | ||
| SpringApplication.run(BaseApplication.class, args); | ||
| } | ||
|
|
||
| } |
28 changes: 28 additions & 0 deletions
28
...che/ehcache/base/src/main/java/com/alipay/sofa/cache/ehcache/rest/CacheConfiguration.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| package com.alipay.sofa.cache.ehcache.rest; | ||
|
|
||
| import org.springframework.cache.annotation.EnableCaching; | ||
| import org.springframework.cache.ehcache.EhCacheCacheManager; | ||
| import org.springframework.cache.ehcache.EhCacheManagerFactoryBean; | ||
| import org.springframework.context.annotation.Bean; | ||
| import org.springframework.context.annotation.Configuration; | ||
| import org.springframework.core.io.ClassPathResource; | ||
|
|
||
| @Configuration | ||
| @EnableCaching | ||
| public class CacheConfiguration { | ||
|
|
||
| @Bean(name = "baseEhcacheCacheManager") | ||
| public EhCacheCacheManager ehCacheCacheManager(EhCacheManagerFactoryBean bean) { | ||
| return new EhCacheCacheManager(bean.getObject()); | ||
| } | ||
|
|
||
| @Bean | ||
| public EhCacheManagerFactoryBean ehCacheManagerFactoryBean() { | ||
| EhCacheManagerFactoryBean factoryBean = new EhCacheManagerFactoryBean(); | ||
|
|
||
| factoryBean.setShared(false); | ||
| factoryBean.setCacheManagerName("baseEhcacheCacheManager"); | ||
| factoryBean.setConfigLocation(new ClassPathResource("ehcache.xml")); | ||
| return factoryBean; | ||
| } | ||
| } |
Oops, something went wrong.