com.baidu.bjf.remoting.protobuf.ProtobufIDLGenerator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jprotobuf Show documentation
Show all versions of jprotobuf Show documentation
A useful utility library for java programmer using google protobuf.
/*
* Copyright (c) Baidu Inc. All rights reserved.
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.baidu.bjf.remoting.protobuf;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.baidu.bjf.remoting.protobuf.annotation.Ignore;
import com.baidu.bjf.remoting.protobuf.annotation.Package;
import com.baidu.bjf.remoting.protobuf.annotation.Protobuf;
import com.baidu.bjf.remoting.protobuf.annotation.ProtobufClass;
import com.baidu.bjf.remoting.protobuf.utils.FieldInfo;
import com.baidu.bjf.remoting.protobuf.utils.ProtobufProxyUtils;
/**
*
* Utility class for generate protobuf IDL content from @{@link Protobuf}
*
* @author xiemalin
* @since 1.0.1
*/
public class ProtobufIDLGenerator {
/** The Constant GOOGLE_PROTOBUF_ANY_DEF. */
public static final String GOOGLE_PROTOBUF_ANY_DEF = "google.protobuf.Any";
/** Logger for this class. */
private static final Logger LOGGER = LoggerFactory.getLogger(ProtobufIDLGenerator.class.getName());
/** The Constant V3_HEADER. */
private static final String V3_HEADER = "syntax=\"proto3\"";
/**
* get IDL content from class.
*
* @param cls target class to parse for IDL message.
* @param cachedTypes if type already in set will not generate IDL. if a new type found will add to set
* @param cachedEnumTypes if enum already in set will not generate IDL. if a new enum found will add to set
* @param ignoreJava set true to ignore generate package and class name
* @return protobuf IDL content in string
* @see Protobuf
*/
public static String getIDL(final Class cls, final Set> cachedTypes,
final Set> cachedEnumTypes, boolean ignoreJava) {
Ignore ignore = cls.getAnnotation(Ignore.class);
if (ignore != null) {
LOGGER.info("class '{}' marked as @Ignore annotation, create IDL ignored.", cls.getName());
return null;
}
Set> types = cachedTypes;
if (types == null) {
types = new HashSet>();
}
Set> enumTypes = cachedEnumTypes;
if (enumTypes == null) {
enumTypes = new HashSet>();
}
if (types.contains(cls)) {
return null;
}
StringBuilder code = new StringBuilder();
code.append(V3_HEADER).append(";\n");
if (!ignoreJava) {
String pkgName = cls.getPackage().getName();
Package annotation = cls.getAnnotation(Package.class);
if (annotation != null) {
pkgName = annotation.value();
}
// define package
code.append("package ").append(pkgName).append(";\n");
code.append("option java_package = \"").append(pkgName).append("\";\n");
code.append("option java_outer_classname = \"").append(cls.getSimpleName()).append("$$ByJProtobuf\";\n");
}
// define outer name class
types.add(cls);
generateIDL(code, cls, types, enumTypes);
return code.toString();
}
/**
* get IDL content from class.
*
* @param cls target class to parse for IDL message.
* @param cachedTypes if type already in set will not generate IDL. if a new type found will add to set
* @param cachedEnumTypes if enum already in set will not generate IDL. if a new enum found will add to set
* @return protobuf IDL content in string
* @see Protobuf
*/
public static String getIDL(final Class cls, final Set> cachedTypes,
final Set> cachedEnumTypes) {
return getIDL(cls, cachedTypes, cachedEnumTypes, false);
}
/**
* get IDL content from class.
*
* @param cls target protobuf class to parse
* @return protobuf IDL content in string
*/
public static String getIDL(final Class cls) {
return getIDL(cls, null, null);
}
/**
* @param code
* @param cls
* @return sub message class list
*/
private static void generateIDL(StringBuilder code, Class cls, Set> cachedTypes,
Set> cachedEnumTypes) {
Set> subTypes = new HashSet>();
Set> enumTypes = new HashSet>();
Annotation annotation = cls.getAnnotation(ProtobufClass.class);
if (annotation != null && ((ProtobufClass) annotation).description() != null) {
code.append("//").append(((ProtobufClass) annotation).description()).append("\n");
}
code.append("message ").append(cls.getSimpleName()).append(" { \n");
List fieldInfos = ProtobufProxyUtils.fetchFieldInfos(cls, false);
boolean isMap = false;
for (FieldInfo field : fieldInfos) {
if (field.hasDescription()) {
code.append("// ").append(field.getDescription()).append("\n");
}
if (field.getFieldType() == FieldType.OBJECT || field.getFieldType() == FieldType.ENUM) {
if (field.isList()) {
Type type = field.getField().getGenericType();
if (type instanceof ParameterizedType) {
ParameterizedType ptype = (ParameterizedType) type;
Type[] actualTypeArguments = ptype.getActualTypeArguments();
if (actualTypeArguments != null && actualTypeArguments.length > 0) {
Type targetType = actualTypeArguments[0];
if (targetType instanceof Class) {
Class c = (Class) targetType;
String fieldTypeName;
if (ProtobufProxyUtils.isScalarType(c)) {
FieldType fieldType = ProtobufProxyUtils.TYPE_MAPPING.get(c);
fieldTypeName = fieldType.getType();
} else if (c.equals(Any.class)) {
// add Any supports visit
// requirement #https://github.com/jhunters/jprotobuf/issues/156
fieldTypeName = GOOGLE_PROTOBUF_ANY_DEF;
} else {
if (field.getFieldType() == FieldType.ENUM) {
if (!cachedEnumTypes.contains(c)) {
cachedEnumTypes.add(c);
enumTypes.add(c);
}
} else {
if (!cachedTypes.contains(c)) {
cachedTypes.add(c);
subTypes.add(c);
}
}
fieldTypeName = c.getSimpleName();
}
code.append("repeated ").append(fieldTypeName).append(" ")
.append(field.getField().getName()).append("=").append(field.getOrder())
.append(";\n");
}
}
}
} else {
Class c = field.getField().getType();
code.append(getFieldRequired(field.isRequired())).append(" ").append(c.getSimpleName()).append(" ")
.append(field.getField().getName()).append("=").append(field.getOrder()).append(";\n");
if (field.getFieldType() == FieldType.ENUM) {
if (!cachedEnumTypes.contains(c)) {
cachedEnumTypes.add(c);
enumTypes.add(c);
}
} else {
if (!cachedTypes.contains(c)) {
cachedTypes.add(c);
subTypes.add(c);
}
}
}
} else {
String type = field.getFieldType().getType().toLowerCase();
if (field.getFieldType() == FieldType.ENUM) {
// if enum type
Class c = field.getField().getType();
if (Enum.class.isAssignableFrom(c)) {
type = c.getSimpleName();
if (!cachedEnumTypes.contains(c)) {
cachedEnumTypes.add(c);
enumTypes.add(c);
}
}
} else if (field.getFieldType() == FieldType.MAP) {
isMap = true;
Class keyClass = field.getGenericKeyType();
Class valueClass = field.getGenericeValueType();
if (keyClass == null) {
keyClass = String.class;
}
if (valueClass == null) {
valueClass = Object.class;
}
type = type + "<" + ProtobufProxyUtils.processProtobufType(keyClass) + ", ";
type = type + ProtobufProxyUtils.processProtobufType(valueClass) + ">";
// check map key or value is object type
if (ProtobufProxyUtils.isObjectType(keyClass)) {
if (Enum.class.isAssignableFrom(keyClass)) {
if (!cachedEnumTypes.contains(keyClass)) {
cachedEnumTypes.add(keyClass);
enumTypes.add(keyClass);
}
} else {
if (!cachedTypes.contains(keyClass)) {
cachedTypes.add(keyClass);
subTypes.add(keyClass);
}
}
}
if (ProtobufProxyUtils.isObjectType(valueClass)) {
if (Enum.class.isAssignableFrom(valueClass)) {
if (!cachedEnumTypes.contains(valueClass)) {
cachedEnumTypes.add(valueClass);
enumTypes.add(valueClass);
}
} else {
if (!cachedTypes.contains(valueClass)) {
cachedTypes.add(valueClass);
subTypes.add(valueClass);
}
}
}
}
String required = getFieldRequired(field.isRequired());
if (isMap) {
required = "";
}
if (field.isList()) {
required = "repeated";
}
code.append(required).append(" ").append(type).append(" ").append(field.getField().getName())
.append("=").append(field.getOrder()).append(";\n");
}
}
code.append("}\n");
for (Class subType : enumTypes) {
generateEnumIDL(code, subType);
}
if (subTypes.isEmpty()) {
return;
}
for (Class subType : subTypes) {
generateIDL(code, subType, cachedTypes, cachedEnumTypes);
}
}
private static void generateEnumIDL(StringBuilder code, Class cls) {
code.append("enum ").append(cls.getSimpleName()).append(" { \n");
Field[] fields = cls.getFields();
for (Field field : fields) {
String name = field.getName();
code.append(name).append("=");
try {
Enum value = Enum.valueOf(cls, name);
if (value instanceof EnumReadable) {
code.append(((EnumReadable) value).value());
} else {
code.append(value.ordinal());
}
code.append(";\n");
} catch (Exception e) {
continue;
}
}
code.append("}\n ");
}
/**
* @param protobuf
* @return
*/
private static String getFieldRequired(boolean required) {
return "";
}
}