← Zurück zum Blog

Java: Datei in Spring Boot aus dem Classpath laden

Übersetzter Artikel. Original lesen

Einleitung

Bei einer Spring-Boot-Webanwendung müssen manchmal Dateien aus dem Classpath geladen werden, wenn Daten nur als Datei vorliegen. In meinem Fall verwendete ich eine MaxMind-GeoLite2-Datenbank zur Geolokalisierung. Dafür musste die Datei geladen und ein im Serverspeicher gehaltenes DatabaseReader-Objekt erstellt werden.

Im Folgenden stehen Lösungen für WAR- und JAR-Archive.

Der ResourceLoader

In Java kann der ClassLoader des aktuellen Threads eine Datei laden. Das Spring Framework bietet mit dem ResourceLoader jedoch eine elegantere Lösung.

Der ResourceLoader wird injiziert; anschließend genügt der Aufruf getResource("somePath").

Datei in Spring Boot aus dem Ressourcenverzeichnis laden (WAR)

Das folgende Beispiel lädt GeoLite2-Country.mmdb als Ressource aus dem Classpath und ruft sie anschließend als File-Objekt ab.

@Service("geolocationservice")
public class GeoLocationServiceImpl implements GeoLocationService {

    private static final Logger LOGGER = LoggerFactory.getLogger(GeoLocationServiceImpl.class);

    private static DatabaseReader reader = null;

    private ResourceLoader resourceLoader;

    @Autowired
    public GeoLocationServiceImpl(ResourceLoader resourceLoader) {
        this.resourceLoader = resourceLoader;
    }

    @PostConstruct
    public void init() {
        try {
            LOGGER.info("GeoLocationServiceImpl: Trying to load GeoLite2-Country database...");

            Resource resource = resourceLoader.getResource("classpath:GeoLite2-Country.mmdb");
            File dbAsFile = resource.getFile();

            // Initialize the reader
            reader = new DatabaseReader
                        .Builder(dbAsFile)
                        .fileMode(Reader.FileMode.MEMORY)
                        .build();

            LOGGER.info("GeoLocationServiceImpl: Database was loaded successfully.");

        } catch (IOException | NullPointerException e) {
            LOGGER.error("Database reader cound not be initialized. ", e);
        }
    }

    @PreDestroy
    public void preDestroy() {
        if (reader != null) {
            try {
                reader.close();
            } catch (IOException e) {
                LOGGER.error("Failed to close the reader.");
            }
        }
    }
}

Datei aus einem Spring-Boot-JAR laden

Soll eine Datei aus dem Classpath eines Spring-Boot-JAR geladen werden, muss resource.getInputStream() verwendet werden. resource.getFile() führt zu einem Fehler, weil Spring auf einen Dateisystempfad zugreifen möchte, ein Pfad innerhalb des JAR aber nicht als normale Datei erreichbar ist.

@Service("geolocationservice")
public class GeoLocationServiceImpl implements GeoLocationService {

    private static final Logger LOGGER = LoggerFactory.getLogger(GeoLocationServiceImpl.class);

    private static DatabaseReader reader = null;
    private ResourceLoader resourceLoader;

    @Inject
    public GeoLocationServiceImpl(ResourceLoader resourceLoader) {
        this.resourceLoader = resourceLoader;
    }

    @PostConstruct
    public void init() {
        try {
            LOGGER.info("GeoLocationServiceImpl: Trying to load GeoLite2-Country database...");

            Resource resource = resourceLoader.getResource("classpath:GeoLite2-Country.mmdb");
            InputStream dbAsStream = resource.getInputStream(); // <-- this is the difference

            // Initialize the reader
            reader = new DatabaseReader
                        .Builder(dbAsStream)
                        .fileMode(Reader.FileMode.MEMORY)
                        .build();

            LOGGER.info("GeoLocationServiceImpl: Database was loaded successfully.");

        } catch (IOException | NullPointerException e) {
            LOGGER.error("Database reader cound not be initialized. ", e);
        }
    }

    @PreDestroy
    public void preDestroy() {
        if (reader != null) {
            try {
                reader.close();
            } catch (IOException e) {
                LOGGER.error("Failed to close the reader.");
            }
        }
    }
}