Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bewaremypower/shadeplugindemo
An example to use maven-shade-plugin.
https://github.com/bewaremypower/shadeplugindemo
kafka maven shaded
Last synced: 28 days ago
JSON representation
An example to use maven-shade-plugin.
- Host: GitHub
- URL: https://github.com/bewaremypower/shadeplugindemo
- Owner: BewareMyPower
- Created: 2021-06-30T17:21:34.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-07-05T09:36:26.000Z (over 3 years ago)
- Last Synced: 2024-11-14T07:46:25.767Z (3 months ago)
- Topics: kafka, maven, shaded
- Language: Java
- Homepage:
- Size: 32.2 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ShadePluginDemo
An example to use [maven-shade-plugin](https://maven.apache.org/plugins/maven-shade-plugin/).
## Get started
Make sure you have already run a local [Kafka]() broker that listens at localhost:9092.
First build the project:
```bash
mvn clean install
```
Then run the demo:
```bash
mvn exec:java -Dexec.mainClass=Demo -pl demo
```
## What's this?
It's an example that makes a class use variant versions of Kafka client. Usually we can't import the same dependency with multiple versions. However, with the help of maven-shade-plugin, we can archive the similar result.
For example, this project has multiple modules:
- kafka-1-0-0
- kafka-2-0-0
Each module wraps a different version of Kafka client. Without the maven-shade-plugin, the `demo` module, which imports these modules as the dependencies, will only choose **one** version of `org.apache.kafka:kafka-clients`.
## Wrong version and commit id
You may see followed logs.
```
2021-07-01 00:51:37:581 [Demo.main()] INFO org.apache.kafka-1-0-0.common.utils.AppInfoParser - Kafka version : 1.0.0
2021-07-01 00:51:37:581 [Demo.main()] INFO org.apache.kafka-1-0-0.common.utils.AppInfoParser - Kafka commitId : aaa7af6d4a11b29d
```
It's okay because `AppInfoParser` reads the version and commit id from the same `/kafka/kafka-version.properties`.
## Intellj Idea
Intellij Idea doesn't support maven-shade-plugin well, if you just click the button to run `Demo.main`, the classes may still be loaded from `org.apache.kafka` package but not `org.apache.kafka-x-y-z` package.
To solve this issue, you need to:
1. Right click on `pom.xml` of shaded modules like `kafka_1_0`.
2. Choose "Maven" - "Ignore Projects".
3. Right click on the `pom.xml` of the project.
4. Choose "Maven" - "Reload project".
Then Idea will load classes from shaded JARs. However, since shaded modules are ignored by Idea, the code completion is disabled for these modules. So we need to reimport the shaded modules.
1. Right click on `pom.xml` of shaded modules like `kafka_1_0`.
2. Choose "Maven" - "Unignore Projects".
See [here](https://stackoverflow.com/questions/30407065/getting-intellij-to-import-shaded-dependencies-in-a-multi-module-maven-project/30898810) for reference.