实现Kong的Java管理API - Kong最佳实践

Kong提供了Http的管理API,可以实现对Kong的管理。我们利用Kong的Amin API,实现一套JAVA的管理API。这里以添加一个Service和Route为示例:

使用retrofit2实现

添加Maven依赖

<dependency>
            <groupId>com.squareup.retrofit2</groupId>
            <artifactId>retrofit</artifactId>
            <version>${retrofit.version}</version>
        </dependency>
        <dependency>
            <groupId>com.squareup.retrofit2</groupId>
            <artifactId>converter-gson</artifactId>
            <version>${retrofit.version}</version>
            <exclusions>
                <exclusion>
                    <groupId>com.google.code.gson</groupId>
                    <artifactId>gson</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
            <version>2.8.1</version>
        </dependency>

实现kong客户端的架子

添加Kong客户端

@Data
public class KongClient {

    private ServiceService serviceService;
    private RouteService routeService;

    public KongClient(String adminUrl) {

        if (adminUrl == null || adminUrl.isEmpty()) {
            throw new IllegalArgumentException("The adminUrl cannot be null or empty!");
        }
        RetrofitServiceCreator retrofitServiceCreatorForAdminUrl = new RetrofitServiceCreator(adminUrl);
        {
            serviceService = retrofitServiceCreatorForAdminUrl.create(ServiceService.class,RetrofitServiceService.class);
            routeService = retrofitServiceCreatorForAdminUrl.create(RouteService.class,RetrofitRouteService.class);
        }
  }
}

添加Retrofit处理类

public class RetrofitServiceCreator {

    private Retrofit retrofit;


    // -------------------------------------------------------------------

    public RetrofitServiceCreator(String baseUrl) {

        retrofit = new Retrofit.Builder()
                .baseUrl(baseUrl)
                .client(initOkHttpClient(baseUrl.toLowerCase().startsWith("https"))) // support https
                .addConverterFactory(CustomGsonConverterFactory.create()) // replace GsonConverterFactory

    }

    // -------------------------------------------------------------------

    @SuppressWarnings("unchecked")
    public <T> T create(Class<T> serviceInterface, Class<?> retrofitServiceInterface) {
        Object proxied = retrofit.create(retrofitServiceInterface);
        return (T) Proxy.newProxyInstance(
                RetrofitServiceCreator.class.getClassLoader(),
                new Class[] { serviceInterface },
                new RetrofitBodyExtractorInvocationHandler(proxied));
    }

    public <T> T createRetrofitService(Class<T> retrofitServiceInterface) {
        return retrofit.create(retrofitServiceInterface);
    }

    // -------------------------------------------------------------------

    private OkHttpClient initOkHttpClient(boolean supportHttps) {

        if(supportHttps) {
            HttpsUtil.SSLParams sslParams = HttpsUtil.getSslSocketFactory(null, null, null);
            OkHttpClient okHttpClient = new OkHttpClient.Builder()
                    .sslSocketFactory(sslParams.sSLSocketFactory, sslParams.trustManager)
                    .build();
            return okHttpClient;
        }

        return new OkHttpClient.Builder().build();
    }
}

添加动态代理处理类

@Slf4j
public class RetrofitBodyExtractorInvocationHandler implements InvocationHandler {

    private Object proxied;

    public RetrofitBodyExtractorInvocationHandler(Object proxied) {
        this.proxied = proxied;
    }

    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        String methodName = method.getName();
        Class<?>[] parameterTypes = method.getParameterTypes();
        Method method1 = proxied.getClass().getMethod(methodName, parameterTypes);
        Call call = (Call) method1.invoke(proxied, args);
        Response response = call.execute();
        log.debug("Http Request:  " + response.raw().request());
        log.debug("Http Response: " + response.raw().toString());
        if(!response.isSuccessful()) {
            throw new KongClientException(response.errorBody() != null ? response.errorBody().string() : String.valueOf(response.code()));
        }
        return response.body();
    }
}

添加自定义JSON转换工厂

class CustomGsonConverterFactory extends Converter.Factory {

    private final Gson gson;

    private CustomGsonConverterFactory(Gson gson) {
        if (gson == null) throw new NullPointerException("gson == null");
        this.gson = gson;
    }

    public static CustomGsonConverterFactory create() {
        return create(new Gson());
    }

    public static CustomGsonConverterFactory create(Gson gson) {
        return new CustomGsonConverterFactory(gson);
    }

    @Override
    public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) {
        TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(type));
        return new CustomGsonResponseBodyConverter<>(gson, adapter);
    }

    @Override
    public Converter<?, RequestBody> requestBodyConverter(Type type,Annotation[] parameterAnnotations, Annotation[] methodAnnotations, Retrofit retrofit) {
        TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(type));
        return new CustomGsonRequestBodyConverter<>(gson, adapter);
    }
}

实现Service的Java Admin API

添加Service实体

@Data @Builder
public class Service {

    private String id;
    private String name;
    private String protocol;
    private String host;
    private Integer port;
    private String path;
    private String url;
    private Integer retries;
    @SerializedName("connect_timeout")
    private Long connectTimeout;
    @SerializedName("read_timeout")
    private Long readTimeout;
    @SerializedName("write_timeout")
    private Long writeTimeout;
    @SerializedName("created_at")
    private Long createdAt;
    @SerializedName("updated_at")
    private Long updatedAt;
}

添加Service接口,这里只要删除和新增

public interface ServiceService {

    Service addService(Service service);
    void deleteService(String nameOrId);
}

添加Retrofit的处理接口

public interface RetrofitServiceService {

    @POST("services/")
    Call<Service> addService(@Body Service request);
    @DELETE("services/{nameOrId}")
    Call<Void> deleteService(@Path("nameOrId") String nameOrId);
}

实现Route的Java Admin API

添加Route实体

@Data @Builder
public class Route {

    private String id;
    private List<String> protocols;
    private List<String> methods;
    private List<String> hosts;
    private List<String> paths;
    @SerializedName("strip_path")
    private Boolean stripPath;
    @SerializedName("preserve_host")
    private Boolean preserveHost;
    private Service  service;
    @SerializedName("created_at")
    private Long createdAt;
    @SerializedName("updated_at")
    private Long updatedAt;
}

添加Route接口,这里只要删除和新增

public interface RouteService {

    Route addRoute(Route route);
    void DeleteRoute(String id);
}

添加Retrofit的处理接口

public interface RetrofitRouteService {
    @POST("routes/")
    Call<Route> addRoute(@Body Route route);
    @DELETE("routes/{id}")
    Call<Void> DeleteRoute(@Path("id") String id);
}

单元测试一下

新建一个名字为example-service,地址为http://mockbin.org的Service。并为Service添加host为example.com的Route路由。

public class ServiceRouteTest extends BaseTest {

    public static final String EXAMPLE_SERVICE = "example-service";

    @Test
    public void createServiceAndRouteTest(){

        // 删除Route和Service
        CommonList<Route> commonList = kongClient.getRouteService().listRoutesByService(EXAMPLE_SERVICE);
        List<Route> routeList = commonList.getData();
        if(null!=routeList && routeList.size()>0 ){
            for (Route route : routeList) {
                kongClient.getRouteService().DeleteRoute(route.getId());
            }
        }
        kongClient.getServiceService().deleteService(EXAMPLE_SERVICE);


        // 新建Service和Route
        Service service = Service.builder().url("http://mockbin.org").name(EXAMPLE_SERVICE).build();
        Service response4service = kongClient.getServiceService().addService(service);
        printJson(response4service);
        List<String> hostList = new ArrayList<>();
        hostList.add("example.com");
        Route route = Route.builder().hosts(hostList).service(Service.builder().id(response4service.getId()).build()).build();
        Route response4route = kongClient.getRouteService().addRoute(route);
        printJson(response4route);
    }

}

最后,检查下效果

使用GET方法,访问地址http://192.168.56.112:8000,并添加在头部添加host[]=example.com,结果如下:

使用Postman测试Kong

写在最后

  • 利用架子可以自定义其他Kong的JAVA客户端。
  • 很多时候,我们的API地址是通过程序扫描出来的,或者管理系统进行配置的。这个时候,我们就可以利用Kong的JAVA客户端快速的实现Kong的接口管理,轮训等。
  • 应用降级,流控,金丝雀,灰度等等,都可以通过Kong的JAVA客户端轻松实现。

穿梭机:开源API网关系统(Kong教程)入门到精通

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,511评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,495评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,595评论 0 225
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,558评论 0 190
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,715评论 3 270
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,672评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,112评论 2 291
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,837评论 0 181
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,417评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,928评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,316评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,773评论 2 234
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,253评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,827评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,440评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,523评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,583评论 2 249

推荐阅读更多精彩内容