Simple ways to add and work with a `.jar` file in your local maven setup
0 likes177 views
The document provides various methods for working with a .jar file in a local Maven setup, including adding the .jar as an IntelliJ project dependency, installing it to the local .m2 repository, or using a repository management tool like Nexus or Archiva. It emphasizes the importance of choosing the right approach based on the project's requirements, from quick hacks to strategic long-term solutions like publishing to Maven Central. Additionally, the document includes practical commands and links for further guidance on managing local .jar files.
Simple ways to add and work with a `.jar` file in your local maven setup
- 1. Simple ways to work with a .jar file in your local maven dependency setup Alan Richardson www.javafortesters.com www.eviltester.com www.compendiumdev.co.uk www.seleniumsimplified.com @eviltester @EvilTester 1
- 2. Sometimes you want to work with a jar file that isn't hosted in maven central. You can: add .jar files as an IntelliJ project dependency install it locally to your .m2 repository add it to your project as a system scoped file use a repository management tool: like Nexus or Archiva publish the dependency to maven central @EvilTester 2
- 3. Quick Hack ‐ add jar as an IntelliJ project dependency For very quick hacks, add the .jar as an IntelliJ project dependency and bypass maven. Open Module Settings Add .jar as Library I demonstrate this in my free Java Desktop Application Technical Testing and you can read a blog post containing this information. @EvilTester 3
- 4. Quick Hack ‐ add jar as an IntelliJ project dependency Very tactical approach: it doesn't scale it doesn't help you work with other people it isn't very good for CI or version control But it might help you get your immediate work done: experiment try something out get a task completed And then adopt one of the following approaches if it works. @EvilTester 4
- 5. Add to project as system scoped file As a short term tactic, I have also added the .jar as a system scoped file. <dependency> <groupId>selenium_2_53_1</groupId> <artifactId>com.seleniumhq.selenium_2_53_1 </artifactId> <version>2.53.1</version> <scope>system</scope> <systemPath> C:/temp/selenium‐server‐standalone‐2.53.1.jar </systemPath> </dependency> I don't think it really scales strategically. e.g. see blog post on seleniumsimplified.com/2016/06 @EvilTester 5
- 6. Install .jar locally to your .m2 repository To have the .jar available as a dependency that I can bring in using a normal maven include, I can install the .jar locally to my .m2 directory and repository. This is explained on the maven website: https://maven.apache.org/guides/mini/guide‐3rd‐party‐jars‐ local.html @EvilTester 6
- 7. Install .jar locally to your .m2 repository I use this approach when working with my RestMud game engine I have split my game into two projects: game engine e.g. https://github.com/eviltester/restmud‐game‐engine RestMud game, Web Server and REST API I build a snapshot .jar of the game engine locally for my work. @EvilTester 7
- 8. Install .jar locally to your .m2 repository Install it into my .m2 folder mvn install:install‐file ‐Dfile=target/restmud‐engine‐1.4‐SNAPSHOT.jar ‐DpomFile=pom.xml @EvilTester 8
- 9. Install .jar locally to your .m2 repository If I didn't have the pom.xml file, I could still do this. I just add the details from the pom.xml into my command line: mvn install:install‐file ‐Dfile=target/restmud‐engine‐1.4‐SNAPSHOT.jar ‐DgroupId=uk.co.compendiumdev ‐DartifactId=restmud‐engine ‐Dversion=1.4‐SNAPSHOT ‐Dpackaging=jar @EvilTester 9
- 10. Install .jar locally to your .m2 repository If I want the source code jar to be associated with the .jar add the following argument to the command line: ‐Dsources=target/restmud‐engine‐1.4‐SNAPSHOT‐sources.jar @EvilTester 10
- 11. Install .jar locally to your .m2 repository This allows me to keep the pom.xml of my projects which use the .jar to remain as though the .jar was on a repository manager or in maven central. good tactical approach, supports a switch to longer term strategic development @EvilTester 11
- 12. Use a repository management tool You could install a dependency management tool Nexus Archiva Your .jar files are installed into this repository which is accessible by your team, and CI process and not just your local development machine. Maven docs on Repositories: https://maven.apache.org/repository‐management.html @EvilTester 12
- 13. Use a repository management tool You have to: install the dependency management tool configure the pom.xml to have a <repositories> section and point to your dependency management tool This is a much more strategic approach and is good for team work and continuous integration processes. @EvilTester 13
- 14. Publish to Maven Central probably the most strategic long term approach, requires you to make your work public. All of the other approaches mentioned allow you to keep your work to yourself. It is quite a long process, so I won't describe it here, but I have a full write up on my blog. http://blog.javafortesters.com/2016/10/how‐to‐create‐and‐release‐ jar‐to‐maven.html @EvilTester 14
- 15. Summary Ultimate short term hack ‐ add as a dependency in your IDE For quick hacks ‐ add it as system scoped maven dependency For personal work, or moving towards a strategic approach, install locally to .m2 For longer term tactical work as a team, use a repository manager For strategic open source work, release to maven central @EvilTester 15
- 16. Useful Links Install .jar into your local .m2 folder or as System scope https://maven.apache.org/guides/mini/guide‐3rd‐party‐jars‐ local.html https://stackoverflow.com/questions/4955635/how‐to‐add‐ local‐jar‐files‐to‐a‐maven‐project http://seleniumsimplified.com/2016/06/use_selenium_webdrive r_jar_locally/ http://roufid.com/3‐ways‐to‐add‐local‐jar‐to‐maven‐project Example code that has the mvn install instructions in it is my restmud‐game‐engine @EvilTester 16
- 17. End Alan Richardson www.compendiumdev.co.uk Linkedin ‐ @eviltester Twitter ‐ @eviltester Instagram ‐ @eviltester Facebook ‐ @eviltester Youtube ‐ EvilTesterVideos Pinterest ‐ @eviltester Github ‐ @eviltester Slideshare ‐ @eviltester @EvilTester 17
- 18. BIO Alan is a test consultant who enjoys testing at a technical level using techniques from psychotherapy and computer science. In his spare time Alan is currently programming a multi‐user text adventure game and some buggy JavaScript games in the style of the Cascade Cassette 50. Alan is the author of the books "Dear Evil Tester", "Java For Testers" and "Automating and Testing a REST API". Alan's main website is compendiumdev.co.uk and he blogs at blog.eviltester.com @EvilTester 18