将源代码包含在JAR文件中有什么弊端？

Question

To assist in our ability to step through code when debugging I'd like to recommend our JAR files be built to include source code. I'm wondering what issues that might cause. My immediate thought was that the JAR files would be slightly larger. I can live with that. Are there other issues I need to consider?

TIA

Answer 1

Normally you separate compiled code and source code into two different jars.

Then you can attach the source-code jar in your IDE when you need to debug the code.

A build tool like maven will easily do that for you.

Answer 2

I highly recommend it. I do this and so do some open source projects (eg jMock, Hamcrest, GWT).

It saves fussing about with separate source jars. It also means that if at some point in the future the source project is lost (as sometimes happens in large organizations) the maintenance programmers down the line will have a fighting chance of recreating it.

If you're happy that those people with access to the jar can see your source code and are prepared to pay the penalty of an increase in jar size (and a probably negligible increase in the time to create, transfer and deploy the jar) then that's all you need to worry about. There aren't any other issues as far as I am aware.

Just because the Maven standard is to keep source files separate doesn't mean you have to do it that way.

Answer 3

I would normally create a separate source .jar. Maven can easily create this , and IDEs know how to access/download these.

Answer 4

Some tools in the java space will take the source files from the classpath (ie from within the jar) and do nasty things.

Typically where you see this is if you add a dependency on a jar that does this... then you end up with those source files being compiled again into the dependent project and bundled in its jar and then all classloader hell breaks loose as classes get loaded from one source and another.

Just don't do it. Follow the Maven way (even if not using Maven) and create a separate -sources.jar