利用Ant与Proguard混淆引用的子工程项目jar包及打war包

[url]http://jimmy-duan.iteye.com/blog/1057967[/url]

当前的web项目有引用到子工程项目，而且多个子工程项目也有引用到其它的工程项目，现要求利用Ant自动将web项目打包成war包，其中引用到的子工程项目需打成jar包，而且必须是混淆后的jar包。其中混淆代码的工具选择了开源的Proguard([url]http://proguard.sourceforge.net/[/url])，可以运行proguard自带的proguardgui.jar(图形化用户界面)生成proguard配置文件。


[b]ProGuard是一个免费的java类文件压缩,优化,混淆器.它探测并删除没有使用的类,字段,方法和属性.它删除没有用的说明并使用字节码得到最大优化.它使用无意义的名字来重命名类,字段和方法. [/b]

ProGuard的使用是为了:

1.创建紧凑的代码文档是为了更快的网络传输,快速装载和更小的内存占用.
2.创建的程序和程序库很难使用反向工程.
3.所以它能删除来自源文件中的没有调用的代码
4.充分利用java6的快速加载的优点来提前检测和返回java6中存在的类文件.

[color=red]参数： [/color]

-include {filename} 从给定的文件中读取配置参数

-basedirectory {directoryname} 指定基础目录为以后相对的档案名称

-injars {class_path} 指定要处理的应用程序jar,war,ear和目录

-outjars {class_path} 指定处理完后要输出的jar,war,ear和目录的名称

-libraryjars {classpath} 指定要处理的应用程序jar,war,ear和目录所需要的程序库文件

-dontskipnonpubliclibraryclasses 指定不去忽略非公共的库类。

-dontskipnonpubliclibraryclassmembers 指定不去忽略包可见的库类的成员。


[color=red]保留选项 [/color]
-keep {Modifier} {class_specification} 保护指定的类文件和类的成员

-keepclassmembers {modifier} {class_specification} 保护指定类的成员，如果此类受到保护他们会保护的更好

-keepclasseswithmembers {class_specification} 保护指定的类和类的成员，但条件是所有指定的类和类成员是要存在。

-keepnames {class_specification} 保护指定的类和类的成员的名称（如果他们不会压缩步骤中删除）

-keepclassmembernames {class_specification} 保护指定的类的成员的名称（如果他们不会压缩步骤中删除）

-keepclasseswithmembernames {class_specification} 保护指定的类和类的成员的名称，如果所有指定的类成员出席（在压缩步骤之后）

-printseeds {filename} 列出类和类的成员-keep选项的清单，标准输出到给定的文件

[color=red]压缩 [/color]
-dontshrink 不压缩输入的类文件

-printusage {filename}

-whyareyoukeeping {class_specification}

[color=red]优化 [/color]
-dontoptimize 不优化输入的类文件

-assumenosideeffects {class_specification} 优化时假设指定的方法，没有任何副作用

-allowaccessmodification 优化时允许访问并修改有修饰符的类和类的成员

[color=red]混淆 [/color]
-dontobfuscate 不混淆输入的类文件

-printmapping {filename}

-applymapping {filename} 重用映射增加混淆

-obfuscationdictionary {filename} 使用给定文件中的关键字作为要混淆方法的名称

-overloadaggressively 混淆时应用侵入式重载

-useuniqueclassmembernames 确定统一的混淆类的成员名称来增加混淆

-flattenpackagehierarchy {package_name} 重新包装所有重命名的包并放在给定的单一包中

-repackageclass {package_name} 重新包装所有重命名的类文件中放在给定的单一包中

-dontusemixedcaseclassnames 混淆时不会产生形形色色的类名

-keepattributes {attribute_name,...} 保护给定的可选属性，例如LineNumberTable, LocalVariableTable, SourceFile, Deprecated, Synthetic, Signature, and InnerClasses.

-renamesourcefileattribute {string} 设置源文件中给定的字符串常量


因为我们开发的是struts2+spring+openjpa的架构的项目，所有需要很详细的配置，其中proguard需要的injars,outjars还有其它的一些libraryjars在Ant的build.xml文件以参数形式加入。
proguard.pro文件具体内容：

-libraryjars <java.home>/lib/rt.jar
-libraryjars <java.home>/lib/jce.jar
-libraryjars <java.home>/lib/jsse.jar

-obfuscationdictionary dictionaries/compact.txt
-classobfuscationdictionary dictionaries/shakespeare.txt

# -printmapping proguard.map
-overloadaggressively
-defaultpackage ''
# -flattenpackagehierarchy ''
# -dontusemixedcaseclassnames
# -keeppackagenames
-allowaccessmodification
-dontoptimize
[color=red]# 因为项目中使用到了jpa的Annotation注解，需要保留这个属性[/color]
-keepattributes *Annotation*

#[color=red] Keep web listener-class，自己编写的web listener，不能混淆，不然启动服务的时候会报错[/color]
-keep public class com.test.mylistener {
public protected *;
}

[color=red]# Keep jpa dao, 自身编写的一些dao接口不能混淆，而且如果是有被spring管理的dao, 也应该不进行混淆[/color]
-keep public class com.test.dao.* {
public protected *;
}
[color=red]# 其中jpa dao中使用到的一些重要接口也能进行混淆[/color]
-keep public class com.test.persistence.core.QueryLiteral {
public protected *;
}
-keep public class com.test.persistence.JpaDao {
public protected *;
}

[color=red]# Keep beans managed by spring framework，spring管理的bean不进行混淆[/color]
-keep public class com.test.provider.* {
public protected *;
}

# Keep Network interface
-keep public class com.test.loader.Network {
public protected *;
}

# Keep entity classes extends java.io.Serializable
[color=red]# 保留jpa中使用到的所有实体类，不进行混淆[/color]
-keep public class * implements java.io.Serializable{
public protected private *;
}

-keep public class com.test.entity.* {
public protected private *;
}

# Keep - Applications. Keep all application classes, along with their 'main' methods.
-keepclasseswithmembers public class * {
public static void main(java.lang.String[]);
}

# Keep names - Native method names. Keep all native class/method names.
-keepclasseswithmembers,allowshrinking class * {
native <methods>;
}


proguard和build.xml文件具体目录结构：
server工程
-src目录
-build目录
-proguard目录
-dictionaries 主要存放混淆时需要用到字典文件，可以使用官网下载到的proguard.zip包中dictionaries的两个文件(dictionaries/compact.txt，dictionaries/shakespeare.txt)
-lib 存放proguard.jar包，这是混淆中使用到的最主要的一个jar包(下载到的proguard.zip中)
-proguard.pro 主要的混淆配置文件
-build.xml


Ant的build.xml文件编写如下：

<?xml version="1.0" encoding="UTF-8"?>
<project name="com.ibm.crl.scm.crc.server" default="dist" basedir=".">  
    <target name="init" description="设置初始化打war包需要的路径变量">  
        <!-- 你的eclipse工作空间站目录路径，以备引用到子工程项目使用-->
    	<property name="workspace" value="${basedir}/../"/>
    	<!-- 需要被打包成war包的主工程项目-->
    	<property name="server.name" value="server"/>
    	<!-- 主工程项目引用到的其它子工程项目-->
    	<property name="childproject1.name" value="childproject1"/>
    	<property name="childproject2.name" value="childproject2"/>

        <property name="src" value="${basedir}/src"/>
    	<property name="resources" value="${basedir}/resources"/>
        <property name="lib" value="${basedir}/WebContent/WEB-INF/lib"/>  
    	<property name="webapp" value="${basedir}/WebContent"/>  

    	<property name="proguard" value="${basedir}/proguard"/> 
    	<property name="proguard.lib" value="${proguard}/lib"/> 

        <property name="build.src" value="${basedir}/build/src"/>  
        <property name="build.dest" value="${basedir}/build/WEB-INF/classes"/>  
        <property name="buildwar.dest" value="${basedir}/build/server"/>  
        <property name="war.dest" value="${basedir}/build/war"/>  
         <!-- 该目录是存储引用到的子工程混淆后的jar包--> 
        <property name="referenced.lib" value="${basedir}/build/referenced"/>  

        <path id="classpath">  
            <fileset dir="${referenced.lib}">  
                <include name="**/*.jar"/>  
            </fileset>  
            <fileset dir="${lib}">  
                <include name="**/*.jar"/>  
            </fileset>  
        </path>  
    </target>  

    <target name="prepare" depends="init" description="创建打包需要的路径，拷贝源文件到打包路径下">  
        <mkdir dir="${build.src}"/>  
        <mkdir dir="${build.dest}"/>  
        <mkdir dir="${buildwar.dest}"/>  
        <mkdir dir="${war.dest}"/>  
        <mkdir dir="${referenced.lib}"/>  
        <copy todir="${build.src}">  
            <fileset dir="${src}"/>  
            <fileset dir="${resources}"/>  
        </copy>  
        <copy todir="${buildwar.dest}">  
            <fileset dir="${webapp}"/>  
        </copy>  
    </target>  

      <!-- 因为当前我们项目中，各个子工程项目有互相引用的情况，打包成jar包就成问题了，所以直接将eclipse自动编译的.class文件打包成jar包，然后再进行混淆-->
	<target name="references" depends="prepare" description="将引用到的子工程打包成jar文件">
		<jar destfile="${referenced.lib}/${childproject1.name}.jar">
			<fileset dir="${workspace}/${childproject1.name}/bin"/>
		</jar>
	  	<jar destfile="${referenced.lib}/${childproject2.name}.jar">
	  	    <fileset dir="${workspace}/${childproject2.name}/bin"/>
	      </jar> 	
	</target>

	<target name="proguard" depends="references" description="混淆引用到的子工程jar文件，并替换">
		<taskdef resource="proguard/ant/task.properties" classpath="${proguard.lib}/proguard.jar" />
		<proguard configuration="${proguard}/proguard.pro">
			<injar file="${referenced.lib}/${childproject1.name}.jar"/>
			<outjar file="${referenced.lib}/OB_${childproject1.name}.jar"/>
			<injar file="${referenced.lib}/${childproject2.name}.jar"/>
			<outjar file="${referenced.lib}/OB_${childproject2.name}.jar"/>
			<libraryjar dir="${lib}"/>
		</proguard>
		<move file="${referenced.lib}/OB_${childproject1.name}.jar" tofile="${referenced.lib}/${childproject1.name}.jar"/>
		<move file="${referenced.lib}/OB_${childproject2.name}.jar" tofile="${referenced.lib}/${childproject2.name}.jar"/>
	</target>

    <target name="build" depends="proguard" description="编译java文件，拷贝properties属性配置文件到编译后的路径下">  
        <javac srcdir="${build.src}" destdir="${build.dest}">  
            <classpath refid="classpath"/>  
        </javac>  
        <copy todir="${build.dest}">  
            <fileset dir="${build.src}">  
                <include name="**/*.properties"/>
            	<include name="**/server.keystore"/> 
            	<include name="**/*.xml"/> 
            </fileset>  
        </copy>  
    </target>  

    <target name="dist" depends="build" description="打war包，不将java文件打入包内">  
        <delete dir="${build.src}"/>  
        <war warfile="${war.dest}/${server.name}.war" webxml="${buildwar.dest}/WEB-INF/web.xml">  
            <lib dir="${referenced.lib}/"/>  
            <classes dir="${build.dest}"/>  
            <fileset dir="${buildwar.dest}"/>  
        </war>
    	<antcall target="clean"></antcall>
    </target>  

    <target name="clean" depends="init" description="清除打包用临时文件">  
        <delete dir="${build.src}"/>  
    	<delete dir="${basedir}/build/WEB-INF"/>  
        <delete dir="${buildwar.dest}"/>  
    </target>  

    <target name="cleanAll" depends="clean" description="清除所有打包生成文件">  
        <delete dir="${war.dest}"/>  
        <delete dir="${referenced.lib}"/>
    </target> 
</project>