On the use of protostaff [easy to understand]

Hello everyone , I meet you again , I'm your friend, Quan Jun .

On Protostuff Use

Studying recently RPC, I saw a man called Protostuff The library of , It's based on Google Protocal Buffer Serialization Library , I've seen it before Protocol Buffer, Yes, after learning some materials , Wrote a demo, recorded .

What is? Protocol Buffer？

Protocol Buffer It is a data exchange format produced by Google , Language and platform independent , Be similar to json.Google Provides the implementation of multiple languages ：java、c++、go and python. Object serialization Protocol Buffer After that, the readability is poor , But compared to the xml,json, It takes up less , Fast . Suitable for data storage or RPC Data exchange format .

Java Serialization Library – Protostuff

Compared with our common json Come on ,Protocol Buffer The threshold is higher , Because I need to write .proto file , Then compile it into the target language , This is very troublesome to use . But now with protostuff after , You don't need to rely on .proto The file , He can speak directly to POJO Serialization and deserialization , It's very simple to use .

actual combat

Create a new one SpringBoot Project , To introduce Protostuff Dependence

      <dependency>
           <groupId>io.protostuff</groupId>
           <artifactId>protostuff-core</artifactId>
           <version>${protostuff.version}</version>
       </dependency>

       <dependency>
           <groupId>io.protostuff</groupId>
           <artifactId>protostuff-runtime</artifactId>
           <version>${protostuff.version}</version>
       </dependency>

Copy

First write two POJO, Then nest them , It's used here lombok Of @Data Notes and @Builder annotation ,@Data Can be generated automatically getter setter,@Builder Annotations allow us to create objects through more elegant builder patterns .

@Data
@Builder
public class User { 
   
    private String id;

    private String name;

    private Integer age;

    private String desc;
}

Copy

@Data
@Builder
public class Group { 
   
    private String id;

    private String name;

    private User user;
}

Copy

Next write Protostuff Serialization tool class

public class ProtostuffUtils { 
   
    /** *  Avoid reapplying every time you serialize Buffer Space  */
    private static LinkedBuffer buffer = LinkedBuffer.allocate(LinkedBuffer.DEFAULT_BUFFER_SIZE);
    /** *  cache Schema */
    private static Map<Class<?>, Schema<?>> schemaCache = new ConcurrentHashMap<>();

    /** *  Serialization method , Serializes the specified object into a byte array  * * @param obj * @param <T> * @return */
    @SuppressWarnings("unchecked")
    public static <T> byte[] serialize(T obj) {
        Class<T> clazz = (Class<T>) obj.getClass();
        Schema<T> schema = getSchema(clazz);
        byte[] data;
        try {
            data = ProtostuffIOUtil.toByteArray(obj, schema, buffer);
        } finally {
            buffer.clear();
        }

        return data;
    }

    /** *  Deserialization method , Deserialize the byte array to the specified Class type  * * @param data * @param clazz * @param <T> * @return */
    public static <T> T deserialize(byte[] data, Class<T> clazz) {
        Schema<T> schema = getSchema(clazz);
        T obj = schema.newMessage();
        ProtostuffIOUtil.mergeFrom(data, obj, schema);
        return obj;
    }

    @SuppressWarnings("unchecked")
    private static <T> Schema<T> getSchema(Class<T> clazz) {
        Schema<T> schema = (Schema<T>) schemaCache.get(clazz);
        if (Objects.isNull(schema)) {
            // This schema adopt RuntimeSchema Create and cache 
            // So you can always call RuntimeSchema.getSchema(), This method is thread safe 
            schema = RuntimeSchema.getSchema(clazz);
            if (Objects.nonNull(schema)) {
                schemaCache.put(clazz, schema);
            }
        }

        return schema;
    }
}

Copy

Verify serialization function

@SpringBootApplication
public class Application implements CommandLineRunner { 
   
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @Override
    public void run(String... strings) throws Exception {
        // Create a user object 
        User user = User.builder().id("1").age(20).name(" Zhang San ").desc("programmer").build();
        // Create a Group object 
        Group group = Group.builder().id("1").name(" grouping 1").user(user).build();
        // Use ProtostuffUtils serialize 
        byte[] data = ProtostuffUtils.serialize(group);
        System.out.println(" After serialization ：" + Arrays.toString(data));
        Group result = ProtostuffUtils.deserialize(data, Group.class);
        System.out.println(" After deserialization ：" + result.toString());
    }
}

Copy

You can see that the console prints out the following data , Description serialization and deserialization succeeded

 After serialization ：[10, 1, 49, 18, 7, -27, -120, -122, -25, -69, -124, 49, 27, 10, 1, 49, 18, 6, -27, -68, -96, -28, -72, -119, 24, 20, 34, 10, 112, 114, 111, 103, 114, 97, 109, 109, 101, 114, 28]
 After deserialization ：Group(id=1, name= grouping 1, user=User(id=1, name= Zhang San , age=20, desc=programmer))

Copy

Last , The code is here Address , welcome star.

Reference resources

• https://github.com/protostuff/protostuff

Publisher ： Full stack programmer stack length , Reprint please indicate the source ：https://javaforall.cn/133960.html Link to the original text ：https://javaforall.cn