生成kafka内部请求与响应的接口文档
生成kafka内部请求与响应的接口文档
/**
*/
package com.code260.ss.kafka10demo;
import java.io.File;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.net.URL;
import java.net.URLDecoder;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import org.apache.kafka.common.protocol.types.BoundField;
import org.apache.kafka.common.protocol.types.Schema;
import org.apache.kafka.common.requests.AbstractRequest;
import org.apache.kafka.common.requests.AbstractResponse;
/**
* @since 2019-08-07
*
*/
public class GenKafkaRequestDoc {
/**
* @param args
* @throws IOException
* @throws ClassNotFoundException
*/
public static void main(String[] args) throws IOException, ClassNotFoundException {
collect(AbstractRequest.class);
System.out.println("=======");
collect(AbstractResponse.class);
}
/**
* @param sedClazz
* @throws IOException
* @throws ClassNotFoundException
*/
public static void collect(Class<?> sedClazz) throws IOException, ClassNotFoundException {
List<Class<?>> children = getAllChildrenClass("org.apache.kafka", sedClazz);
List<Class<?>> childrenOfAbstractRequest = filter(children, sedClazz);
for (Class<?> rquestClazz : childrenOfAbstractRequest) {
System.out.println("\n## " + rquestClazz.getSimpleName());
try {
Schema[] schemas = (Schema[]) rquestClazz.getDeclaredMethod("schemaVersions").invoke(null);
for (int i = 0; i < schemas.length; i++) {
Schema schema = schemas[i];
System.out.println("\n### version:" + i);
StringBuffer sb = new StringBuffer();
sb.append(
"<table><tr><td style=\"width:160px\">name</td><td>type</td><td style=\"width:80px\">defaultValue</td><td>docString</td></tr>");
for (int j = 0; j < schema.fields().length; j++) {
BoundField field = schema.fields()[j];
sb.append("<tr><td>").append(field.def.name).append("</td>");
sb.append("<td>").append(field.def.type).append("</td>");
sb.append("<td>").append(field.def.defaultValue).append("</td>");
sb.append("<td>").append(field.def.docString).append("</td></tr>").append("\n");
}
sb.append("</table> \n \n ");
System.out.println(sb.toString());
}
// System.out.println(schemas);
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
} catch (NoSuchMethodException e) {
e.printStackTrace();
} catch (SecurityException e) {
e.printStackTrace();
}
}
}
private static List<Class<?>> filter(List<Class<?>> children, Class<?> parentClazz) {
List<Class<?>> result = new ArrayList<Class<?>>();
if (children == null || children.isEmpty()) {
return result;
}
for (Class<?> child : children) {
if (isAssignedFrom(child, parentClazz)) {
result.add(child);
}
}
return result;
}
private static boolean isAssignedFrom(Class<?> currentClazz, Class<?> targetParentClazz) {
if (targetParentClazz == null || currentClazz == null) {
return false;
}
// Class<?>[] parentInterfaces = currentClazz.getInterfaces();
Class<?> parentClazz = currentClazz.getSuperclass();
while (parentClazz != null) {
if (parentClazz.equals(targetParentClazz)) {
return true;
} else {
parentClazz = parentClazz.getSuperclass();
}
}
Class<?>[] parentInterfaces = currentClazz.getInterfaces();
return isAssignedFrom(parentInterfaces, targetParentClazz);
}
private static boolean isAssignedFrom(Class<?>[] parentInterfaces, Class<?> targetParentClazz) {
if (parentInterfaces == null) {
return false;
}
for (Class<?> ppInterface : parentInterfaces) {
if (ppInterface != null && ppInterface.equals(targetParentClazz)) {
return true;
} else {
boolean result = isAssignedFrom(ppInterface.getInterfaces(), targetParentClazz);
if (result) {
return true;
}
}
}
return false;
}
private static List<Class<?>> getAllChildrenClass(String scanPackageStr, Class<?> parentClazz)
throws IOException, ClassNotFoundException {
List<Class<?>> children = new ArrayList<Class<?>>();
Enumeration<URL> packageLocations = parentClazz.getClassLoader().getResources(scanPackageStr.replace(".", "/"));
while (packageLocations.hasMoreElements()) {
URL packageLocation = packageLocations.nextElement();
String protocol = packageLocation.getProtocol();
if ("file".equals(protocol)) {
String filePath = URLDecoder.decode(packageLocation.getFile(), "UTF-8");
findAndAddClassesInPackageByFile(filePath, scanPackageStr, children);
} else if ("jar".equals(protocol)) {
findAndAddClassesInPackageByJar(packageLocation.getPath(), scanPackageStr, children);
}
}
return children;
}
private static void findAndAddClassesInPackageByJar(String packageLocation, String packageName,
List<Class<?>> clazzList) throws IOException, ClassNotFoundException {
String[] segs = packageLocation.split("!");
String jarFilePath = segs[0].substring(segs[0].indexOf("/"));
jarFilePath = URLDecoder.decode(jarFilePath, "UTF-8");
String packagePath = segs[1].substring(1);
JarFile jarFile = null;
try {
jarFile = new JarFile(jarFilePath);
Enumeration<JarEntry> entrys = jarFile.entries();
while (entrys.hasMoreElements()) {
JarEntry jarEntry = entrys.nextElement();
String entryName = jarEntry.getName();
if (entryName.endsWith(".class")) {
if (entryName.startsWith(packagePath)) {
entryName = entryName.replace("/", ".").substring(0, entryName.lastIndexOf("."));
Class<?> clazz = Thread.currentThread().getContextClassLoader().loadClass(entryName);
clazzList.add(clazz);
}
}
}
} catch (Exception e) {
e.printStackTrace();
}
finally {
if (jarFile != null) {
jarFile.close();
}
}
}
private static void findAndAddClassesInPackageByFile(String filePath, String packageName,
List<Class<?>> clazzList) {
File file = new File(filePath);
File[] children = file.listFiles();
for (File child : children) {
if (child.isDirectory()) {
findAndAddClassesInPackageByFile(child.getAbsolutePath(), packageName + "." + child.getName(),
clazzList);
}
if (child.isFile()) {
if (!child.getName().endsWith(".class")) {
continue;
}
}
String childName = child.getName();
if (!childName.endsWith(".class")) {
continue;
}
String className = packageName + "." + childName.substring(0, childName.length() - ".class".length());
try {
Class<?> clazz = Thread.currentThread().getContextClassLoader().loadClass(className);
clazzList.add(clazz);
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
}
}
}
生成kafka内部请求与响应的接口文档的更多相关文章
- Swagger 接口文档规范
导语: 相信无论是前端还是后端开发,都或多或少地被接口文档折磨过.前端经常抱怨后端给的接口文档与实际情况不一致.后端又觉得编写及维护接口文档会耗费不少精力,经常来不及更新.其实无论是前端调用后端,还是 ...
- Markdown写接口文档,自动添加TOC
上回说到,用Impress.js代替PPT来做项目展示.这回换Markdown来做接口文档好了.(不敢说代替Word,只能说个人感觉更为方便)当然,还要辅之以Git,来方便版本管理. Markdown ...
- Django框架深入了解_05 (Django中的缓存、Django解决跨域流程(非简单请求,简单请求)、自动生成接口文档)
一.Django中的缓存: 前戏: 在动态网站中,用户所有的请求,服务器都会去数据库中进行相应的增,删,查,改,渲染模板,执行业务逻辑,最后生成用户看到的页面. 当一个网站的用户访问量很大的时候,每一 ...
- SpringBoot整合knife4j框架(可生成离线接口文档),并设置接口请求头token默认值
功能和swagger类似 官网地址:https://doc.xiaominfo.com/knife4j/ 这个框架可以设置返回字段的描述 引入依赖 <dependency> <gro ...
- drf07 过滤 排序 分页 异常处理 自动生成接口文档
4. 过滤Filtering 对于列表数据可能需要根据字段进行过滤,我们可以通过添加django-fitlter扩展来增强支持. pip install django-filter 在配置文件sett ...
- spring boot:用swagger3生成接口文档,支持全局通用参数(swagger 3.0.0 / spring boot 2.3.2)
一,什么是swagger? 1, Swagger 是一个规范和完整的文档框架, 用于生成.描述.调用和可视化 RESTful 风格的 Web 服务文档 官方网站: https://swagger.i ...
- day74:drf:drf其他功能:认证/权限/限流/过滤/排序/分页/异常处理&自动生成接口文档
目录 1.django-admin 2.认证:Authentication 3.权限:Permissions 4.限流:Throttling 5.过滤:Filtering 6.排序:OrderingF ...
- SpringBoot接口 - 如何生成接口文档之非侵入方式(通过注释生成)Smart-Doc?
通过Swagger系列可以快速生成API文档,但是这种API文档生成是需要在接口上添加注解等,这表明这是一种侵入式方式: 那么有没有非侵入式方式呢, 比如通过注释生成文档? 本文主要介绍非侵入式的方式 ...
- asp.net core 使用 swagger 生成接口文档
参考地址:http://www.cnblogs.com/daxnet/p/6181366.html http://www.jianshu.com/p/fa5a9b76f3ed 微软参考文档:https ...
随机推荐
- create-react-app中的babel配置探索
版本 babel-loader version:"8.1.0" create-react-app:"3.4.1" 三个配置 第一部分: { test: /\.( ...
- [jvm] -- 引用篇
四种引用及其应用场景 强引用 强引用是平常中使用最多的引用,强引用在程序内存不足(OOM)的时候也不会被回收. 使用场景:啥时候都在使用 软引用 软引用在程序内存不足时,会被回收. 使用场景:创建缓存 ...
- Nexus安装与迁移
Maven registry(maven私有仓库) 配置Java export JAVA_HOME=/software/jdk1.7.0_79 export JRE_HOME=${JAVA_HOME} ...
- 为PhpStorm添加Laravel 代码智能提示功能
php artisan clear-compiled //清除bootstrap/compiled.php php artisan ide-helper:generate //为 Facades 生成 ...
- JavaScript 中的模块化
JavaScript 中的模块化 最早的基于立即执行函数,闭包的模块化 const MountClickModule = function(){ let num = 0; const handle ...
- MacOS下JDK8的安装与配置
微信搜索"艺术行者",关注并回复关键词"jdk8"获取安装包和API文档资料! 一.安装环节 1.打开网页 https://www.oracle.com/jav ...
- pandas_数据拆分与合并
import pandas as pd import numpy as np # 读取全部数据,使用默认索引 data = pd.read_excel(r'C:\Users\lenovo\Deskto ...
- PHP is_writeable() 函数
定义和用法 is_writeable() 函数检查指定的文件是否可写. 如果文件可写,该函数返回 TRUE. 该函数是 is_writable() 函数的别名. 语法 is_writeable(fil ...
- PHP tanh() 函数
实例 返回不同数的双曲正切: <?php高佣联盟 www.cgewang.comecho(tanh(M_PI_4) . "<br>");echo(tanh(0.5 ...
- PDOStatement::bindParam
PDOStatement::bindParam — 绑定一个参数到指定的变量名(PHP 5 >= 5.1.0, PECL pdo >= 0.1.0) 说明 语法 bool PDOState ...