Spring Data MongoDB GridFS 3.4

spring-data-mongodb-gridfs-3-4

This article shows a typical usage of MongoDB GridFS with Spring Data MongoDB. This is for MongoDB java driver v3.4 and Spring Data MongoDB v1.10.x. Note that Spring Data MongoDB v2.X introduces breaking changes with the MongoDB java driver 3.6+. This article only shows the usage of the v3.4 driver with Spring Data MongoDB v1.10.x.

FileService Interface

public interface FileService {
    GridFSDBFile find(String id);
    Optional<GridFsResource> findAsResource(String id);
    String store(String name, MultipartFile file);
    void delete(String id);
}

FileService Implementation

We can’t use GridFsTemplate.getResource(String location) here to get the resource because there might be files with the same name. To find the expected file, we need to find a list of the resources that all match the same filename and then filter them by the id after retrieving all the files. This is acceptable because at that point, the InputStream hasn’t been requested yet. GridFsTemplate.getResources(String locationPattern) takes an Ant matching pattern and it returns all resources whose filename passes the test.

GridFsTemplate.store() returns an Object whose string literal could be converted to a ObjectId type. For instance,
ObjectId objectId = new ObjectId(GridFsTemplate.store(...).toString()).

@Service
public class FileServiceImpl implements FileService {
    private GridFsTemplate gridFsTemplate;

    @Autowired
    public FileServiceImpl(final GridFsTemplate gridFsTemplate) {
        this.gridFsTemplate = gridFsTemplate;
    }


    @Override
    public GridFSDBFile find(final String id) {
        ObjectId objectId = new ObjectId(id);
        return gridFsTemplate.findOne(new Query(Criteria.where("_id").is(objectId)));
    }

    @Override
    public Optional<GridFsResource> findAsResource(final String id) {
        return Stream.of(gridFsTemplate.getResources(find(id).getFilename() + "*"))
            .filter(gridFsResource -> gridFsResource.getId().toString().equals(id))
            .findAny();
    }

    @Override
    public String store(String name, final MultipartFile file) {
        try {
            String filename = file.getOriginalFilename();
            if (name != null) {
                filename = FileNameUtils.getExtension(filename)
                    .map(ext -> name + "." + ext)
                    .orElse(name);
            }

            InputStream inputStream = file.getInputStream();
            GridFSFile gridFSFile = gridFsTemplate.store(
                inputStream, filename, file.getContentType());
            if (gridFSFile != null) {
                return gridFSFile.getId().toString();
            } throw new FileException("Failed to save file");
        } catch (IOException e) {
            throw new FileException(e);
        }
    }

    @Override
    public void delete(final String id) {
        ObjectId objectId = new ObjectId(id);
        gridFsTemplate.delete(new Query(Criteria.where("_id").is(objectId)));
    }
}

FileController

@RestController
@RequestMapping("/api/v1/files")
public class FileController {
    private FileService fileService;

    @Autowired
    public FileController(final FileService fileService) {
        this.fileService = fileService;
    }

    @PostMapping
    public Attachment uploadAttachment(@RequestParam("name") String name,
                                 @RequestParam("file") MultipartFile file) {
        String id =  fileService.store(name, file);
        return new Attachment(name, id);
    }

    @GetMapping("/{id}")
    public ResponseEntity<InputStreamResource> downloadFile(@PathVariable("id") String id) {
        Optional<GridFsResource> resourceOptional = fileService.findAsResource(id);

        return resourceOptional.map(resource -> {
            try {
                return ResponseEntity
                    .ok()
                    .contentType(MediaType.valueOf(resource.getContentType()))
                    .header(HttpHeaders.CONTENT_DISPOSITION,
                        "attachment; filename=\"" + resource.getFilename() + "\"")
                    .body(new InputStreamResource(resource.getInputStream()));
            } catch (IOException e) {
                throw new FileException(e);
            }
        }).orElseThrow(() -> new FileException("File not found"));
    }

    @DeleteMapping("/{id}")
    public void deleteFile(@PathVariable("id") String id) {
        fileService.delete(id);
    }

    class Attachment {
        private String name;
        private String fileId;

        Attachment(final String name, final String fileId) {
            this.name = name;
            this.fileId = fileId;
        }
        // Getters and setters...
    }

}

References

  1. Mongo Java Driver v3.4
  2. Spring Data MongoDB v.1.10.16 API
  3. Spring Data MongoDB v.1.10.16 Reference

Comments

Post a Comment

Popular posts from this blog

Creating a Library Project for Spring Boot

creating-a-library-project-for-spring-boot This article introduces the key points when creating a library for spring boot project. It could be common that over the years you have created a number of services that could be reused by other spring projects. It then makes sense to make the reusable modules such as a library and install it in your local repository for later use. Here are the key points to consider when building a spring boot library. release version build plugin dependency injection autoconfigurations Release Version To guarantee spring boot works the way you expect, it is recommended to keep update the release versions of the library so that it supports some versions of the spring boot minor version. A good practice is to monitor change spring boot changelog and see if there are any conflicting dependencies that are used in the library project. If there is, introduce a new version to resolve the conflict. Build Plugin If the projects refere
Read more

Spring Data Repository Query Precedence Tricks

spring-data-repository-query-precedence-tricks Spring Data repository method is very handy but it also comes with its limitation, especially when composed with condition precedence. This article shows one way to work with it and its caveats. Use Case Given the following type: @Entity public class Book { @Id private Long id ; private String title ; private String edition ; // Getters and Setters ... } 1. check if there is any book whose title or edition matches the specified. This one is easy to come up with. We could simply use the keyword Or to compose the query: boolean existsByTitleOrEdition ( String title , String edition ) ; 2. check if there is any book whose title or edition matches the specified and is not itself. This one looks just as easy as the first one, we could have just added another condition and compose with the keyword And : boolean existsByTitleOrEditionAndIdIsNot ( String title , String edi
Read more

Serialize Timestamp To EpochSecond with Jackson

serialize-timestamp-to-epochsecond-with-jackson Some REST API only takes a long as its Date field, such as esriFieldTypeDate from ArcGIS Server Rest API. But with the rich functionality, the Java 8 time API provides, it would be silly to use long as the type for our object modeling. This tip shows how to solve this problem. I started with using LocalDateTime as the type of the timestamp field I want to use`, but Jackson simply serialize it as it does with any other fields, but what I really want is to serialize it to the epoch second. Jackson does provide a new library that supports the JSR 310 which is the date and time API. to use that dependency, we need to add the following to maven: <dependency> <groupId>com.fasterxml.jackson.datatype</groupId> <artifactId>jackson-datatype-jsr310</artifactId> </dependency> At this point, the job is not done yet. The LocalDateTime is not an option because it takes a timezone
Read more