com.feilong.zip.AbstractUnzipHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
The newest version!
/*
 * Copyright (C) 2008 feilong
 *
 * Licensed 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.feilong.zip;

import static com.feilong.core.date.DateUtil.formatDurationUseBeginTimeMillis;
import static com.feilong.core.lang.StringUtil.formatPattern;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.UncheckedIOException;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.feilong.core.Validate;
import com.feilong.io.IOWriteUtil;

/**
 * 抽象的解压缩.
 *
 * @author feilong
 * @since 1.11.4
 */
public abstract class AbstractUnzipHandler implements UnzipHandler{

    /** The Constant LOGGER. */
    private static final Logger LOGGER = LoggerFactory.getLogger(AbstractUnzipHandler.class);

    /**
     * Unzip.
     *
     * @param unZipFilePath
     *            the un zip file path
     * @param outputDirectory
     *            the output directory
     */
    /*
     * (non-Javadoc)
     * 
     * @see com.feilong.tools.compress.UnzipManager#unZip(java.lang.String, java.lang.String)
     */
    @Override
    public void unzip(String unZipFilePath,String outputDirectory){
        Validate.notBlank(unZipFilePath, "unZipFilePath can't be blank!");
        Validate.notBlank(outputDirectory, "outputDirectory can't be blank!");

        //---------------------------------------------------------------
        long beginTimeMillis = System.currentTimeMillis();
        if (LOGGER.isInfoEnabled()){
            LOGGER.info("begin unzip:[{}] to outputDirectory:[{}]", unZipFilePath, outputDirectory);
        }

        //---------------------------------------------------------------

        try{
            handle(unZipFilePath, outputDirectory);
        }catch (IOException e){
            String message = formatPattern("unZipFilePath:[{}],outputDirectory:[{}]", unZipFilePath, outputDirectory);
            throw new UncheckedIOException(message, e);
        }

        //---------------------------------------------------------------
        if (LOGGER.isInfoEnabled()){
            LOGGER.info(
                            "use time:[{}],end unzip:[{}],outputDirectory:[{}]",
                            formatDurationUseBeginTimeMillis(beginTimeMillis),
                            unZipFilePath,
                            outputDirectory);
        }
    }

    //---------------------------------------------------------------

    /**
     * 处理.
     *
     * @param unZipFilePath
     *            the un zip file path
     * @param outputDirectory
     *            the output directory
     * @throws IOException
     *             Signals that an I/O exception has occurred.
     * @since 1.11.4
     */
    protected abstract void handle(String unZipFilePath,String outputDirectory) throws IOException;

    //---------------------------------------------------------------

    /**
     * Handler.
     *
     * @param zipEntryName
     *            the zip entry name
     * @param inputStream
     *            the input stream
     * @param outputDirectory
     *            the output directory
     * @see com.feilong.io.IOWriteUtil#write(InputStream, String, String)
     */
    protected static void write(String zipEntryName,InputStream inputStream,String outputDirectory){
        IOWriteUtil.write(inputStream, outputDirectory, zipEntryName);

        if (LOGGER.isDebugEnabled()){
            LOGGER.debug("unzip [{}] to [{}]", zipEntryName, outputDirectory + File.separator + zipEntryName);
        }
    }

}