How can I build a FatJar for shardingsphere-jdbc and use it correctly ?

[zzyReal666]

Hi！

I had some problems building the mysql encryption application locally：

1. I download source code branch ：master;
2. change file shardingsphere-jdbc-binary-distribution.xml to include all dependencies;
3. run mvn clean install -Prelease -T1C -DskipTests -Djacoco.skip=true -Dcheckstyle.skip=true -Drat.skip=true -Dmaven.javadoc.skip=true -B succeeded;
4. I got a lib include all jar,How do I package them all into one jar?

Now I've solved the problem:

edit shardingsphere-jdbc-binary-distribution.xml:

<dependencySets> <dependencySet> <useProjectArtifact>false</useProjectArtifact> <unpack>false</unpack> <outputDirectory>/</outputDirectory> <includes> <include>*</include> </includes> </dependencySet> </dependencySets>

then I build use cmd mvn clean install -Prelease -T1C -DskipTests -Djacoco.skip=true -Dcheckstyle.skip=true -Drat.skip=true -Dmaven.javadoc.skip=true -B,I got a jar with all dependenies:

I hope to add this to the documentation to help you build native application packages

[linghengqian]

• If I understand correctly, you are making an Uber Jar for ShardingSphere JDBC. But it seems like no one has ever needed the Uber Jar before, so it seems to me that fixing the current issue requires adding a Maven module, probably named org.apache.shardingsphere:shardingsphere-jdbc-all, and using the specific maven-assembly-plugin configuration to make the Uber Jar, and then adding documentation for that only makes sense. There is still room for change in the module name.
• I'm assuming you're going to submit a PR. If you don't have time to prepare a PR, I will set an additional issue tag for this issue.

[zzyReal666]

• If I understand correctly, you are making an Uber Jar for ShardingSphere JDBC. But it seems like no one has ever needed the Uber Jar before, so it seems to me that fixing the current issue requires adding a Maven module, probably named org.apache.shardingsphere:shardingsphere-jdbc-all, and using the specific maven-assembly-plugin configuration to make the Uber Jar, and then adding documentation for that only makes sense. There is still room for change in the module name.
• I'm assuming you're going to submit a PR. If you don't have time to prepare a PR, I will set an additional issue tag for this issue.

1. First of all, thank you very much for letting me know the concept of Uber jar. I just want to get it.
2. Usually we use it(shardingsphere-jdbc) as in the documentation:
3. Suppose I had to change some code now.How should I build the project so that these changes take effect?So I want to make an Uber jar.And I use it that way in my project.Use it instead of maven dependency:
   4.Although this can work, I think it is the wrong approach.Uber jar is bigger than shardingsphere-jdbc-5.4.2-SNAPSHOT.jar,and it different from shardingsphere-jdbc-5.4.2-SNAPSHOT.jar:
   

5.How can I get a jar just like shardingsphere-jdbc-5.4.2-SNAPSHOT.jar which get from maven repo?

[linghengqian]

How can I get a jar just like shardingsphere-jdbc-5.4.2-SNAPSHOT.jar which get from maven repo?

• I don’t understand what you are talking about. If you have executed the following command via SDKMAN!, then obviously shardingsphere-jdbc has entered the local maven repo. This really only covers the content of the Apache Maven documentation.

sdk install java 21.0.2-graalce
sdk use java 21.0.2-graalce

git clone [email protected]:apache/shardingsphere.git
cd ./shardingsphere/
git reset --hard e9f622b82de3e20a2d0fe74c87bd67e604e36140
./mvnw clean install -Prelease -T1C -DskipTests -Djacoco.skip=true -Dcheckstyle.skip=true -Drat.skip=true -Dmaven.javadoc.skip=true

• At this point it can be called directly in gradle or maven.

<dependency>
            <groupId>org.apache.shardingsphere</groupId>
            <artifactId>shardingsphere-jdbc</artifactId>
            <version>5.4.2-SNAPSHOT</version>
</dependency>

• If you need to upload the contents of the local maven repo to a private maven repo, this is not something ShardingSphere should handle. Assuming you are using the package registry for a private instance of gitlab, you should check out the documentation at https://docs.gitlab.com/16.9/ee/user/packages/maven_repository/ . This often involves redefining GAV information in private projects.

[zzyReal666]

How can I get a jar just like shardingsphere-jdbc-5.4.2-SNAPSHOT.jar which get from maven repo?

• I don’t understand what you are talking about. If you have executed the following command via SDKMAN!, then obviously shardingsphere-jdbc has entered the local maven repo. This really only covers the content of the Apache Maven documentation.

sdk install java 21.0.2-graalce
sdk use java 21.0.2-graalce

git clone [email protected]:apache/shardingsphere.git
cd ./shardingsphere/
git reset --hard e9f622b82de3e20a2d0fe74c87bd67e604e36140
./mvnw clean install -Prelease -T1C -DskipTests -Djacoco.skip=true -Dcheckstyle.skip=true -Drat.skip=true -Dmaven.javadoc.skip=true

• At this point it can be called directly in gradle or maven.

<dependency>
            <groupId>org.apache.shardingsphere</groupId>
            <artifactId>shardingsphere-jdbc</artifactId>
            <version>5.4.2-SNAPSHOT</version>
</dependency>

• If you need to upload the contents of the local maven repo to a private maven repo, this is not something ShardingSphere should handle. Assuming you are using the package registry for a private instance of gitlab, you should check out the documentation at https://docs.gitlab.com/16.9/ee/user/packages/maven_repository/ . This often involves redefining GAV information in private projects.

1. Thank you again for your reply.
2. How to build a FatJAR (or called Uber jar) ?
3. I use this maven config ,got an Uber jar ,but it can not work and with some wrong:

ERROR

I have report this issue at #29381 (comment)

[linghengqian]

• I can't know the full content of the changes from the image. At least you need to raise a PR in your own ShardingSphere fork or provide the github url of the change commit. Your log is from a private project, so I can't see the full content either.

[zzyReal666]

It seems to be similar to this :#17042 (comment) new module just like xxx-all.But I don't know how to do it. @linghengqian

[linghengqian]

• It looks like the 5.5.0 milestone will be closed tomorrow, I will look into this issue on the 5.5.1 milestone.

[zzyReal666]

Hi!Any plans for this?Is there anything I can do?

[linghengqian]

Hi!Any plans for this?Is there anything I can do?

• An embarrassing thing involved here is that I am not sure where to put the new module. Maybe it is in the /shardingsphere/uber/ directory? The 5.5.0 milestone was delayed due to metadata architecture adjustments.
• The more embarrassing thing is that as a student, I don't have energy to investigate current issues recently. Potential discussions and PRs are still welcome.

[linghengqian]

• I just realized that Consider about provide all-in-one jar #13609 has this requirement, but the original issue didn't mention the concept of an Uber Jar.

• CC @totalo. Are you still working on Consider about provide all-in-one jar #13609 ?

[github-actions[bot]]

There hasn't been any activity on this issue recently, and in order to prioritize active issues, it will be marked as stale.

[tia-ru]

Use "maven-shade-plugin" to build uber-jar

<dependencies>
        <dependency>
            <groupId>org.apache.shardingsphere</groupId>
            <artifactId>shardingsphere-jdbc</artifactId>
            <version>${shardingsphere.version}</version>
        </dependency>
... <!-- another  artifacts -->

</dependencies>
 <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.6.0</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <!--<useDependencyReducedPomInJar>true</useDependencyReducedPomInJar>-->
                    <artifactSet>
                        <includes>
                            <include>*:*</include>
                        </includes>
                        <excludes>
                            <exclude>*:commons-logging</exclude>
                        </excludes>
                    </artifactSet>
                    <filters>
                        <filter>
                            <artifact>*:*</artifact>
                            <excludes>
                                <exclude>META-INF/*.DSA</exclude>
                                <exclude>META-INF/*.SF</exclude>                             
                            </excludes>
                        </filter>
                    </filters>
                    <transformers>
                        <transformer
                                implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
                        <transformer
                                implementation="org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer">
                            <addHeader>false</addHeader>
                        </transformer>
                        <transformer
                                implementation="org.apache.maven.plugins.shade.resource.ApacheLicenseResourceTransformer"></transformer>
                    </transformers>
                </configuration>
            </plugin>
        </plugins>
    </build>