https://github.com/lahahana/csv

Java Annotation based CSV serialization\deserialization tool. Especially useful for csv report generator application
https://github.com/lahahana/csv

annotation-csv csv java

Last synced: 2 months ago
JSON representation

Java Annotation based CSV serialization\deserialization tool. Especially useful for csv report generator application

• Host: GitHub
• URL: https://github.com/lahahana/csv
• Owner: lahahana
• License: apache-2.0
• Created: 2017-03-23T00:49:03.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-09-12T13:55:18.000Z (over 8 years ago)
• Last Synced: 2025-08-01T20:39:54.745Z (8 months ago)
• Topics: annotation-csv, csv, java
• Language: Java
• Homepage:
• Size: 101 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# csv

Java Annotation based CSV serialization/deserialization tool.It provide batch style api for small scale data, also, provide streaming style api for large scale data.

### # 这是一个根据Java Class Field进行CSV序列化/反序列化的工具，基于注解的形式，只需要在相关类上添加注解，就可以实现自定义的CSV序列化/反序列化方案

通过调用`CsvSerializer.serialize(*)`来进行CSV序列化

相关注解：

* `@CsvIgnore` :此注解为标识性注解，`@Target({ElementType.FIELD})`, 表示该字段在序列化时会被忽略

* `@CsvIgnoreProperties`：此注解`@Target({ElementType.TYPE})`，在类级别指定当前类所拥有字段的哪些在序列化时忽略

* `@CsvProperty`：此注解`@Target({ElementType.TYPE})`，通过指定此注解的`header`，`order`,分别可以实现在序列化时指定指定的字段的csv header的值，字段的序列化顺序。最重要的一个属性是`serializationConvertor/deserializationConvertor`，如果需要对特定字段在序列化/反序列化时进行一些数据转换的操作，可以通过继承`com.alpha.csv.convertor.SerializationConvertor/DeserializationConvertor`接口,实现自定义的Convertor。

**Demo：**

    

    @CsvIgnoreProperties({"country"})    

    public class Address {

    

        private String country = "CN";

    

        @CsvIgnore

        public String state = "ZJ";

    

        private String city = "Hangzhou";

    

    }

    public class Person {

    

        @CsvProperty(header="Name", order=1)

        private String name = "Lahahana";

        @CsvProperty(header="ID", order=0)

        private int id = 10001;

    

        @CsvProperty(header = "Birthday", order=2, convertor = TimeToDateConvertor.class)

        public long birthday= System.currentTimeMillis();

    

        private Address address = new Address();

    

        public static void main(String []args) throws CsvException, IOException {

            List persons = new ArrayList();

            Person person = new Person();

            for(int i=0;i<10;i++)

                list.add(person);    

            FileWriter out = new FileWriter("result.csv");

            CsvSerializer serializer = new CsvSerializer.Builder(out).build();

            serializer.serialize(persons, Person.class);

            serializer.close();

        }

    }

**Result:**  

    ID,Name,Birthday,city  

    10001,Lahahana,Tue Mar 28 21:14:59 GMT+08:00 2017,Hangzhou  

    10001,Lahahana,Tue Mar 28 21:14:59 GMT+08:00 2017,Hangzhou  

    

**Maven Dependency:** 

   ```

      

        com.github.lahahana  

        csv  

        2.0.1  

    

   ```