首先是这个问题如何修改。 在/frameworks/base/Android.mk中,找到如下行: packages_to_document := 在该变量的赋值语句最后添加 xxxxx (这里是你的包的名称,比如com/sina/ui,其实这里就是你的源代码在/frameworks/base/<你的模块>/java/下面的一部分路径,只要能够唯一的匹配到你的代码即可) 即可。
该添加的含义是使MAKE系统在制作OFF-LINE DOCUMENT时包含我们的package. 以此类推,添加其他新的package也可以这样做。
下面简单把android make sdk的过程写一下来说明为什么做这样的修改。调查时是反过来调查的。说明还是按照MAKEFILE的生成的顺序来说明吧。 首先在/frameworks/base/Android.mk中定义了进行sdk building的基本目标对象。 包括对哪些.java文件需要生成API文档,以及这些文档的路径。 然后在/build/core/droiddoc.mk中定义了最终进行build的规则和语句。
Android使用javadoc这个工具来生成所有API文档。 Javadoc这个工具可以带一个参数指定一个文件,该文件包含了所有要生成文档的源文件的名字(全路径)。 该文件的内容就是通过在/framework/base/android.mk里的变量生成的。当然在droiddoc.mk中还添加了build过程中生成的intermediates目录下的文件。
另外javadoc还可以指定定制的doclet(doclet是基于javadoc特定的API开发的小程序,该程序负责实际的文档输出).android的编译系统就包含了这样一个doclet叫DroidDoc。可以在/build/tools/DroidDoc目录下找到该工具的全部源代码。
正是该工具在生成HTML的同时在/out/target/common/obj/JAVA_LIBRARIES/android_stubs_current_intermediates下面copy(或者说重新生成了)所有将生成到android.jar中的所有源代码(.java文件). 该工具把所有生成document的源文件重新按Package组织生成在以上目录下。 然后进行编译和打包成android.jar。 根据以上分析,其实android.jar文件是各个公布出来的 API 的源文件经过javadoc重新组织以后再次编译产生的。 故,android.jar的内容实际上受到javadoc的notation控制和makefile的控制。 对于android中已存在的代码比如wifi native,可以通过修改源代码中javadoc的notation的方法重新build得到新的包含wifi native接口的android.jar(将源文件中的@hide这个notation换成别的,然后make update-api;make sdk)。而对于新加入的代码,则需要如上方法来修改makefile了。 下面总结一下调查过程中涉及到的知识: 1) javadoc和doclet,简单的看了一下工具的使用和参数,另外看了一下DriodDoc这个doclet的源代码,找出哪里生成的.java源文件。 2.makefile分析,android的make showcommands命令可以和任何其他目标一起使用来察看make过程中实际做了一些什么事情。(这点还需要调查这个showcommands如何实现的,因为make -d这个命令给出的信息对于找到问题帮助不大) 3.在跟踪makefile build过程时,使用$(warning xxxxx)和$(error xxxx)可以在除规则以外的地方打印出变量的值通过这个方法找出了实际建立要编译的文件列表的地方。
http://yueguc.iteye.com/blog/820591 主要为了解决如下问题: 项目中使用了Android未公开的API,在Eclipse下会有红叉显示。 不同的项目抽出相同部分的代码共用。
必需的前提条件: 需要有Android源代码,编译的库文件主要是封装未公开API或者共用代码。
工程1:Java库文件工程
该工程最终会生成以jar结尾的Java库文件,并会被安装到设备的以下目录: /system/framework/ 另外还会安装相关库文件的说明文件,使系统能够找到库文件: /system/etc/permissions/
1、建立工程 在Eclipse下新建一个空的Java工程。 在工程的 Java Build Path -> Libraries 下,导入Android的SDK中的 android.jar 库。 为工程创建相应的包和java文件。 下面假设包路径为 com.mytest.lib,最终生成的库为 mylib.jar。
2、为工程添加注册文件 在库文件工程的根目录下创建以下文件: <permission xml file name>.xml 该文件是用来向系统注册库用的,名称可以自己定,在下面假设该文件为 mylibxml.xml。 在文件中加入以下内容: <?xml version="1.0" encoding="UTF-8"?> <permissions> <library name="com.mytest.lib" file="/system/framework/mylib.jar" /> </permissions> 其中的 library 用于将其下的 name 和 file 两个属性关联起来,name 的值后边会用到。 这里的 name 指定为工程的包名。 这里的 file 指定为库文件的存放路径,应该是: /system/framework/<jar file name>.jar
3、为工程添加makefile文件: 在库文件工程的根目录下创建以下文件: Android.mk 该文件是用来编译工程的,名称固定。 在文件中加入以下内容: LOCAL_PATH:= $(call my-dir) #MAKE_JAR include $(CLEAR_VARS) LOCAL_SRC_FILES := $(call all-subdir-java-files) LOCAL_MODULE := mylib include $(BUILD_JAVA_LIBRARY) #MAKE_XML include $(CLEAR_VARS) LOCAL_MODULE := mylibxml.xml LOCAL_MODULE_CLASS := ETC LOCAL_MODULE_PATH := $(TARGET_OUT_ETC)/permissions LOCAL_SRC_FILES := $(LOCAL_MODULE) include $(BUILD_PREBUILT) 其中,MAKE_JAR 部分的 LOCAL_MODULE 部分指定为想要生成的库文件的名字, 需要与 .xml 文件中的 library 下的 file 部分一致。 其中,MAKE_XML 部分的 LOCAL_MODULE 部分指定为用于注册库的 .xml 文件。
4、生成应用程序可用的库文件 此时的工程,如果使用了未公开的API的话,在eclipse下应该是有红叉的。 这些错误不用管,只需要保证程序在Android的源码下能够编译通过即可。 将工程的java文件以及 .xml 和 .mk 按照目录结构拷贝到以下目录: <Android source folder>/packages/apps/<project name>/ 运行以下命令: $ cd <Android source folder> $ . ./build/envsetup.sh $ mmm packages/apps/<project name> 将会生成一个 .jar 文件和一个 .xml 文件。 以上两个文件是应用程序在运行时需要用到的。 调试应用前,需要将两个文件拷贝到设备的相应目录上去: .jar 文件:/system/framework/ .xml 文件:/system/etc/permissions/ 拷贝到设备使用以下命令: $ sudo adb push <.jar or .xml file path> <path in device> 拷贝完以后需要重启设备。
5、生成在Eclipse可以引用的库文件 在源码下编译的 .jar 文件在Eclipse中是不能使用的,需要单独生成。 在Eclipse下选中工程根目录,选择文件菜单中的导出Export,然后选择jar类型。 导出为jar文件时,只需要选中相应的java文件即可。 这样生成的jar文件仅仅供应用程序在Eclipse下使用,除非是以下情况: 库文件没有使用非公开的API,并且, 应用本身在Eclipse下编译就能够使用,不需要到源码下编译。 暂且为该文件命名为mylibtemp.jar
工程2:Android应用工程
1、建立工程 新建一个Android工程。 在工程的 Java Build Path -> Libraries 下,导入 mylibtemp.jar 库。 使用 mylibtemp.jar 中的类编写代码。 下面假设最后生成的应用程序文件为 myapp.apk。
2、编辑AndroidManifest.xml文件 编辑工程根目录下的 AndroidManifest.xml 文件。 在 application 下添加以下内容: <uses-library android:name="com.mytest.lib"> </uses-library> 其中的 :name 表示所引用的库文件的包名。 其与库工程的 .xml 文件中的 name 应该是一致的。 这样在应用运行时就能够找到相应的 .jar 文件了。 如果引用了多个库,需要添加多个 uses-library 标签。
3、为工程添加makefile文件: 在库文件工程的根目录下创建以下文件: Android.mk 该文件是用来编译工程的,名称固定。 在文件中加入以下内容: LOCAL_PATH:= $(call my-dir) include $(CLEAR_VARS) LOCAL_SRC_FILES := $(call all-java-files-under, src) LOCAL_JAVA_LIBRARIES := mylib LOCAL_PACKAGE_NAME := myapp LOCAL_CERTIFICATE := platform include $(BUILD_PACKAGE) 其中的 LOCAL_JAVA_LIBRARIES 表示程序会用到的库文件。 其名成与库工程下的 .mk 文件中 MAKE_JAR 部分下的 LOCAL_MODULE 应该是一致的。 其中的 LOCAL_PACKAGE_NAME 表示应用最后生成的名称。
4、编译应用程序 将工程的 src、res、assets 文件夹以及文件: Android.mk 和 AndroidManifest.xml 按照目录结构拷贝到以下目录: <Android source folder>/packages/apps/<project name>/ 引用的 .jar 库文件并不需要。 运行以下命令: $ cd <Android source folder> $ . ./build/envsetup.sh $ mmm packages/apps/<project name> 将会生成一个 .apk 文件。 运行以下命令将应用安装到设备: $ sudo adb install [-r] <apk file path>
为android开放类增加自定义成员方法
android SDK中有些JAVA类是开放的,有些是不开放的,API同样如此。这里所谓开放的类或API,只是javadoc的范畴,并不是java中public和private,也就是说,对于源码的编译无所谓,只是对javadoc的生成有影响关于类的开放和隐藏,但是对android的上层应用有影响,因为非开放的类或API,android上层应用无法直接访问。 类或API是否开放,是通过doc的注释{@hide}来控制的。比如android.media.Metadata 这个类就是android没有公开的类,因为在frameworks\base\media\libmedia\Metadata.java文件中,定义Metadata类之前有/**{@hide}*/此doc注释,所以Metadata类被定义为了非公开类,即是在android应用程序中无法直接访问的类。 但是如果我们在Android的公开类中添加了一些自定义的成员方法或成员变量,生成我们修改后的sdk(jar包)供上层应用程序使用,此时在编译源码生成SDK的过程中会出现这个问题: ****************************** You have tried to change the API from what has been previously approved. To make these errors go away, you have two choices: 1) You can add "@hide" javadoc comments to the methods, etc. listed in the errors above. 2) You can update current.xml by executing the following commands: p4 edit frameworks/base/api/current.xml make update-api To check in the revised current.xml, you will need OWNERS approval. ****************************** google 给了两个选择: 1. 在你添加的API或者变量前面,增加javadoc 注释@hide。但是要注意的是,并不是简单写个@hide 或者/*@hide*/ 就可以了,这些都是错误的javadoc注释格式,标准的javadoc都是这样的 /** */ 而且对于 format 变量 应该加上 { }。 所以我们应该这样写 /** {@hide} */ 2. 你就是想要生成的javadoc里面出现这个方法或者变量,你必须输入: make update-api 但是如果修改的是google没有开放出来的类,比如RIL,PhoneFactory,就不会出现这个问题,
|