Spring多線(xiàn)程異步上傳圖片、處理水印、縮略圖

使用環(huán)境

• SpringBoot+FastDfs+thumbnailator
• fdfs環(huán)境自己搞吧

基于 Spring Boot + MyBatis Plus + Vue & Element 實(shí)現(xiàn)的后臺(tái)管理系統(tǒng) + 用戶(hù)小程序，支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶(hù)、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

• 項(xiàng)目地址：https://github.com/YunaiV/ruoyi-vue-pro
• 視頻教程：https://doc.iocoder.cn/video/

thumbnailator

maven依賴(lài)：

<dependency>
<groupId>net.coobirdgroupId>
<artifactId>thumbnailatorartifactId>
<version>0.4.8version>
dependency>

工具類(lèi)：

importnet.coobird.thumbnailator.Thumbnails;
importnet.coobird.thumbnailator.geometry.Positions;
importorg.springframework.stereotype.Component;
importjavax.imageio.ImageIO;
importjava.io.File;
importjava.io.IOException;

@Component
publicclassPictureUtil{

/**
*水印圖片
*/
privatestaticFilemarkIco=null;

//開(kāi)機(jī)靜態(tài)加載水印圖片
static{
try{
markIco=newFile(newFile("").getCanonicalPath()+"/icon.png");
LogUtil.info(PictureUtil.class,"水印圖片加載"+(markIco.exists()?"成功":"失敗"));
}catch(Exceptione){
}
}

/**
*加水印
*/
publicvoidphotoMark(FilesourceFile,FiletoFile)throwsIOException{
Thumbnails.of(sourceFile)
.size(600,450)//尺寸
.watermark(Positions.BOTTOM_CENTER/*水印位置：中央靠下*/,
ImageIO.read(markIco),0.7f/*質(zhì)量，越大質(zhì)量越高(1)*/)
//.outputQuality(0.8f)
.toFile(toFile);//保存為哪個(gè)文件
}

/**
*生成圖片縮略圖
*/
publicvoidphotoSmaller(FilesourceFile,FiletoFile)throwsIOException{
Thumbnails.of(sourceFile)
.size(200,150)//尺寸
//.watermark(Positions.CENTER,ImageIO.read(markIco),0.1f)
.outputQuality(0.4f)//縮略圖質(zhì)量
.toFile(toFile);
}

/**
*生成視頻縮略圖（這塊還沒(méi)用到呢）
*/
publicvoidphotoSmallerForVedio(FilesourceFile,FiletoFile)throwsIOException{
Thumbnails.of(sourceFile)
.size(440,340)
.watermark(Positions.BOTTOM_CENTER,ImageIO.read(markIco),0.1f)
.outputQuality(0.8f)
.toFile(toFile);
}
}

這個(gè)插件很好用，只需集成調(diào)用即可，我記得我還試過(guò)另外幾個(gè)，需要另外在linux下配置.so文件的依賴(lài)等等，查了半天也沒(méi)弄明白，很麻煩，這個(gè)方便。

這個(gè)插件又很不好用，必須要先調(diào)整尺寸，才能加水印，而且調(diào)整尺寸簡(jiǎn)直是負(fù)壓縮。壓了分辨率圖片還能變大那種。但是簡(jiǎn)單嘛，這塊不是重點(diǎn)。

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 實(shí)現(xiàn)的后臺(tái)管理系統(tǒng) + 用戶(hù)小程序，支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶(hù)、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

• 項(xiàng)目地址：https://github.com/YunaiV/yudao-cloud
• 視頻教程：https://doc.iocoder.cn/video/

線(xiàn)程池

使用springboot線(xiàn)程池，方便易用，只需配置和加注解即可。

importorg.springframework.context.annotation.Bean;
importorg.springframework.context.annotation.Configuration;
importorg.springframework.core.task.TaskExecutor;
importorg.springframework.scheduling.annotation.EnableAsync;
importorg.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
importjava.util.concurrent.ThreadPoolExecutor;

@Configuration
@EnableAsync
publicclassPoolConfig{
@Bean//returnnewAsyncResult<>(res);
publicTaskExecutortaskExecutor(){
ThreadPoolTaskExecutorexecutor=newThreadPoolTaskExecutor();
executor.initialize();//設(shè)置核心線(xiàn)程數(shù)
executor.setCorePoolSize(4);//設(shè)置最大線(xiàn)程數(shù)
executor.setMaxPoolSize(32);//設(shè)置隊(duì)列容量
executor.setQueueCapacity(512);//設(shè)置線(xiàn)程活躍時(shí)間（秒）
executor.setKeepAliveSeconds(60);//設(shè)置默認(rèn)線(xiàn)程名稱(chēng)
executor.setThreadNamePrefix("ThreadPool-");//設(shè)置拒絕策略
executor.setRejectedExecutionHandler(newThreadPoolExecutor.CallerRunsPolicy());//等待所有任務(wù)結(jié)束后再關(guān)閉線(xiàn)程池
executor.setWaitForTasksToCompleteOnShutdown(true);
returnexecutor;
}
}

避坑知識(shí)點(diǎn)：配置springboot線(xiàn)程池，類(lèi)上需要@Configuration、@EnableAsync這兩個(gè)注解，實(shí)際調(diào)用時(shí)，需要遵守一個(gè)規(guī)則，即在調(diào)用的方法的類(lèi)上必須使用注解@EnableAsync，調(diào)用一個(gè)帶有@Async的方法。

比如A類(lèi)使用了注解@EnableAsync 在A類(lèi)中調(diào)用B類(lèi)的有@Async的方法，只有這樣多線(xiàn)程才生效，A類(lèi)內(nèi)調(diào)用A類(lèi)的@Async方法不生效?？梢岳斫鉃镃ontroller層使用@EnableAsync注解，Service層方法上標(biāo)注@Async。這樣在Controller層調(diào)用的Service方法會(huì)從線(xiàn)程池調(diào)用線(xiàn)程來(lái)執(zhí)行。

異步邏輯：為什么要用多線(xiàn)程？

我畫(huà)了一張簡(jiǎn)單的示意圖，在這個(gè)項(xiàng)目中，客戶(hù)端一次上傳10多張圖片，每個(gè)圖片單獨(dú)上傳，等待所有圖片上傳返回200后，繼續(xù)執(zhí)行操作，如果一步一步處理，客戶(hù)端需等待服務(wù)器處理完所有邏輯，這樣浪費(fèi)沒(méi)必要的時(shí)間。顧使用異步操作，客戶(hù)端只需上傳圖片，無(wú)需等待服務(wù)器處理（我們服務(wù)器很辣雞，一個(gè)10M的圖可能要搞10多秒，見(jiàn)笑）

業(yè)務(wù)代碼

@ApiOperation("上傳業(yè)務(wù)圖片")
@PostMapping("/push/photo/{id}/{name}")
publicRpushHousingPhotoMethod(
@ApiParam("SourceId")@PathVariableIntegerid,
@ApiParam("圖片名稱(chēng)不約束，可不填則使用原名，可使用隨機(jī)碼或原名稱(chēng)，但必須帶擴(kuò)展名")@PathVariable(required=false)Stringname,
@RequestParamMultipartFilefile)throwsInterruptedException,ExecutionException,IOException{
StringfileName=file.getOriginalFilename();
Stringext=StringUtils.substring(fileName,fileName.lastIndexOf('.'),fileName.length());
FiletempPhoto=File.createTempFile(UUIDUtil.make32BitUUID(),ext);
file.transferTo(tempPhoto);//轉(zhuǎn)儲(chǔ)臨時(shí)文件
service.pushPhoto(id,name,tempPhoto);
returnnewR();
}

業(yè)務(wù)代碼里隱藏了一些項(xiàng)目相關(guān)的信息，就是某些名改了，嗯。

可以看到，使用StringUtils.substring(fileName, fileName.lastIndexOf(’.’),fileName.length());這句代碼，調(diào)用apache.common.lang3工具類(lèi)獲取出了擴(kuò)展名，因?yàn)閿U(kuò)展名對(duì)圖片處理工具類(lèi)有用，他通過(guò)擴(kuò)展名識(shí)別圖片格式，所以這個(gè)必須有，如代碼，生成了一個(gè)使用隨機(jī)碼命名，但帶有.png擴(kuò)展名的臨時(shí)文件，保存在默認(rèn)臨時(shí)路徑以供處理。File.createTempFile(UUIDUtil.make32BitUUID(), ext);是生成臨時(shí)文件的方法，UUIDUtil也很簡(jiǎn)單，我貼出來(lái)吧，省著還要找

注意：controller類(lèi)上需要標(biāo)注注解@EnableAsync

/**
*生成一個(gè)32位無(wú)橫杠的UUID
*/
publicsynchronizedstaticStringmake32BitUUID(){
returnUUID.randomUUID().toString().replace("-","");
}

避坑知識(shí)點(diǎn)：Spring使用MultipartFile接收文件，但不能直接把MultipartFile傳下去處理，而是保存為臨時(shí)文件，并不是多此一舉。因?yàn)?code style="font-size:14px;padding:2px 4px;margin-right:2px;margin-left:2px;color:rgb(30,107,184);background-color:rgba(27,31,35,.05);font-family:'Operator Mono', Consolas, Monaco, Menlo, monospace;">MultipartFile也是臨時(shí)文件，他的銷(xiāo)毀時(shí)間是你這個(gè)Controller層方法return的時(shí)候。

如果不使用異步，是可以在調(diào)用的方法里去處理MultipartFile文件的，但如果使用異步處理，肯定是這邊線(xiàn)程還沒(méi)處理完，那邊Controller層已經(jīng)return了，這個(gè)MultipartFile就被刪除了，于是你的異步線(xiàn)程就找不到這張圖了。那還處理個(gè)啥，對(duì)吧。所以需要手動(dòng)保存為自己創(chuàng)建的臨時(shí)文件，再在線(xiàn)程中處理完把他刪掉。

貼Service層Impl實(shí)現(xiàn)類(lèi)代碼

@Async
publicvoidpushHousingPhoto(Integerid,Stringname,Filefile)throwsInterruptedException,ExecutionException,IOException{
//存儲(chǔ)FDFS表id
LongstartTime=System.currentTimeMillis();
Integer[]numb=fastDfsService.upLoadPhoto(StringUtils.isBlank(name)?file.getName():name,file).get();
SourcePhotosContextcontext=newSourcePhotosContext();
context.setSourceId(id);
context.setNumber(numb[0]);
context.setNumber2(numb[1]);
//保存圖片關(guān)系
sourcePhotosContextService.insertNew(context);
LongendTime=System.currentTimeMillis();
LogUtil.info(this.getClass(),"source["+id+"]綁定圖片["+name+"]成功,內(nèi)部處理耗時(shí)["+(endTime-startTime)+"ms]");
//returnnewR();
}

這里的number和number2分別是帶水印的原圖和縮略圖，context是個(gè)表，用來(lái)存圖片和縮略圖對(duì)應(yīng)fdfs路徑的，就不貼了。可見(jiàn)這個(gè)方法上帶有注解@Async 所以整個(gè)方法會(huì)異步執(zhí)行。

加水印處理寫(xiě)到fdfs的service里了，這樣不算規(guī)范，可以不要學(xué)我：

@Override
publicFutureupLoadPhoto(StringfileName,MultipartFilefile)throwsIOException{
Stringext=StringUtils.substring(fileName,fileName.lastIndexOf('.'));
//創(chuàng)建臨時(shí)文件
FilesourcePhoto=File.createTempFile(UUIDUtil.make32BitUUID(),ext);
file.transferTo(sourcePhoto);
returnupLoadPhoto(fileName,sourcePhoto);
}

@Override
publicFutureupLoadPhoto(StringfileName,FilesourcePhoto)throwsIOException{
Stringext=StringUtils.substring(fileName,fileName.lastIndexOf('.'));
//創(chuàng)建臨時(shí)文件
FilemarkedPhoto=File.createTempFile(UUIDUtil.make32BitUUID(),ext);
FilesmallerPhoto=File.createTempFile(UUIDUtil.make32BitUUID(),ext);
//加水印縮圖
pictureUtil.photoMark(sourcePhoto,markedPhoto);
pictureUtil.photoSmaller(markedPhoto,smallerPhoto);
//上傳
IntegermarkedPhotoNumber=upLoadPhotoCtrl(fileName,markedPhoto);
IntegersmallerPhotoNumber=upLoadPhotoCtrl("mini_"+fileName,smallerPhoto);
//刪除臨時(shí)文件
sourcePhoto.delete();
markedPhoto.delete();
smallerPhoto.delete();
Integer[]res=newInteger[]{markedPhotoNumber,smallerPhotoNumber};
returnnewAsyncResult(res);
}

使用了方法重載，一個(gè)調(diào)用了另一個(gè)，方便以后處理MultipartFile和File格式的圖片都能使用，可以見(jiàn)到使用了Future這個(gè)東西作為返回值，完全可以不這么做，正常返回就行。我懶得改了，這也是不斷探索多線(xiàn)程處理圖片的過(guò)程中，遺留下來(lái)的東西。

在service中fastDfsService.upLoadPhoto(StringUtils.isBlank(name) ? file.getName() : name, file).get()這句就是得到了這個(gè)future的內(nèi)容，可以去掉.get() 和Future<>?？梢?jiàn)這一個(gè)小小的異步功能，其實(shí)走過(guò)了很多彎路。future其實(shí)是異步調(diào)用方法時(shí)，從.get()等待異步處理的結(jié)果，等待得到結(jié)果后獲取內(nèi)容并執(zhí)行?，F(xiàn)在使用spring線(xiàn)程池處理，已經(jīng)不需要這樣做了。

以上，希望你在實(shí)現(xiàn)這個(gè)功能時(shí)可以少走彎路。

附總體示意圖：