hsiaosiyuan0/jexpose

Exposing class graph inside of jar

jexpose

This project can expose class graph inside of jar. It has the honour of providing jar infomation to dubbo2.js to generate typescript code.

It is designed to just exposing the matching class files, and will merge fields inherit from ancestor classes. It does not using reflection but reading bytecode within class files, the reason of this strategy is the original language planed to be used to write this project is typescript, used java temporarily since the asm package is ready to use.

After this choc was completed, the typescript version jar-exposer is working in progress and maybe completed in future someday :-]

jexpose -entry com.qianmi -entry-jar /w/qm/uc.jar -lib /w/qm/uc/dependencies -provider-suffix Provider -exclude ".*Score.*"

Option	Meaning
entry	the entry point to start our exposing
entry-jar	path of target jar
lib	path of directory which is comprise of dependencies of target jar
provider-suffix	suffix of provider name
include	regexp for including files
exclude	regexp for excluding files

is_filename_match = (provider-suffix(filename) || include(filename)) && !exclude(filename)

After exposing, jexpose will produce a json file, content of it looks like:

{
  "classes": {
    "com.hsiaosiyuan.ServiceProvider": { ... }
    ...
  },
  "providers": [
    "com.hsiaosiyuan.ServiceProvider"
  ]
}

How to use

PROJ_ROOT refers to the root directory of your project.

1. First, you'll build your project, use mvn package to produce your target jar which is located at PROJ_ROOT/target/xxx.jar

2. Second, you'll collect your project' dependencies, use mvn install dependency:copy-dependencies to copy dependencies of the target jar into PROJ_ROOT/target/dependency

3. Ready to expose, use jexpose com.example PROJ_ROOT/target/example-x.x-SNAPSHOT.jar PROJ_ROOT/target/dependency