向 FtpProvider? 接口添加一個(gè)新方法，需要我們僅在一個(gè)地方進(jìn)行更改。我們可以輕松地將我們的 FtpProvider? 注入到其他服務(wù)中。此解決方案的強(qiáng)項(xiàng)可能是 @FtpOperation? 注釋，它可以在 FtpProvider 上下文實(shí)現(xiàn)之外使用，但是將 Ftp 操作的邏輯劃分到單獨(dú)的類中并不是一個(gè)好方法。
?前言
冗余代碼向來是代碼的一種壞味道，也是我們程序員要極力避免的。今天我通過一個(gè)示例和大家分享下解決冗余代碼的3個(gè)手段，看看哪個(gè)最好。
問題描述
為了描述這個(gè)問題，我將使用 FtpClient 作為示例。要從 ftp 服務(wù)器獲取一些文件，你需要先建立連接，下一步是登錄，然后執(zhí)行查看ftp文件列表、刪除ftp文件，最后注銷并斷開連接， 代碼如下：
public class FtpProvider{
private final FTPClient ftpClient;
public FTPFile[] listDirectories(String parentDirectory) {
try {
ftpClient.connect("host", 22);
ftpClient.login("username", "password");
return ftpClient.listDirectories(parentDirectory);
} catch (IOException ex) {
log.error("Something went wrong", ex);
throw new RuntimeException(ex);
} finally {
try {
ftpClient.logout();
ftpClient.disconnect();
} catch (IOException ex) {
log.error("Something went wrong while finally", ex);
}
}
}
public boolean deleteFile(String filePath) {
try {
ftpClient.connect("host", 22);
ftpClient.login("username", "password");
return ftpClient.deleteFile(filePath);
} catch (IOException ex) {
log.error("Something went wrong", ex);
throw new RuntimeException(ex);
} finally {
try {
ftpClient.logout();
ftpClient.disconnect();
} catch (IOException ex) {
log.error("Something went wrong while finally", ex);
}
}
}
}正如上面代碼所示，listDirectories和downloadFtpFile?中都包含了ftp連接、登錄以及最后的注銷操作，存在大量冗余的代碼，那有什么更好的辦法清理冗余代碼呢？下面推薦3個(gè)做法，所有三個(gè)提出的解決方案都將實(shí)現(xiàn)以下 FtpProvider 接口，我將比較這些實(shí)現(xiàn)并選擇更好的一個(gè)。
public interface FtpProvider {
FTPFile[] listDirectories(String directory) throws IOException;
boolean deleteFile(String filePath) throws IOException;
}1. 使用@Aspect 代理
- 首先創(chuàng)建一個(gè)注解, 用來注解需要代理的方法
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface FtpOperation {
}- 創(chuàng)建一個(gè)類實(shí)現(xiàn) FtpProvider接口, 將注解添加到方法 listDirectories 和 deleteFile 中
@Slf4j
@Service
class FtpProviderImpl implements FtpProvider {
private final FTPClient ftpClient;
@Override
public FTPFile[] listDirectories(String directory) throws IOException {
return ftpClient.listDirectories(directory);
}
@Override
public boolean deleteFile(String filePath) throws IOException {
return ftpClient.deleteFile(filePath);
}
}
@Slf4j
@Aspect
@Component
@RequiredArgsConstructor
public class FtpOperationProxy {
private final FTPClient ftpClient;
@Around("@annotation(daniel.zielinski.redundancy.proxyaop.infrastructure.FtpOperation)")
public Object handle(ProceedingJoinPoint joinPoint) throws Throwable {
try {
ftpClient.connect("host", 22);
ftpClient.login("username", "password");
return joinPoint.proceed();
} catch (IOException ex) {
log.error("Something went wrong", ex);
throw new RuntimeException(ex);
} finally {
try {
ftpClient.logout();
ftpClient.disconnect();
} catch (IOException ex) {
log.error("Something went wrong while finally", ex);
}
}
}
}
所有用@FtpOperation? 注解的方法都會(huì)在這個(gè)地方執(zhí)行joinPoint.proceed()。
2. 函數(shù)式接口
- 創(chuàng)建一個(gè)函數(shù)式接口
@FunctionalInterface
interface FtpOperation<T, R> {
R apply(T t) throws IOException;
}
@RequiredArgsConstructor
@Slf4j
@Service
public class FtpOperationTemplate {
private final FTPClient ftpClient;
public <K> K execute(FtpOperation<FTPClient, K> ftpOperation) {
try {
ftpClient.connect("host", 22);
ftpClient.login("username", "password");
return ftpOperation.apply(ftpClient);
} catch (IOException ex) {
log.error("Something went wrong", ex);
throw new RuntimeException(ex);
} finally {
try {
ftpClient.logout();
ftpClient.disconnect();
} catch (IOException ex) {
log.error("Something went wrong while finally", ex);
}
}
}
}
@RequiredArgsConstructor
@Slf4j
@Service
class FtpProviderFunctionalInterfaceImpl implements FtpProvider {
private final FtpOperationTemplate ftpOperationTemplate;
public FTPFile[] listDirectories(String parentDirectory) {
return ftpOperationTemplate.execute(ftpClient -> ftpClient.listDirectories(parentDirectory));
}
public boolean deleteFile(String filePath) {
return ftpOperationTemplate.execute(ftpClient -> ftpClient.deleteFile(filePath));
}
}
我們正在 FtpOperationTemplate? 上執(zhí)行方法 execute? 并且我們正在傳遞 lambda? 表達(dá)式。我們將放入 lambda? 中的所有邏輯都將代替 ftpOperation.apply(ftpClient) 函數(shù)執(zhí)行。
3. 模板方法
@RequiredArgsConstructor
@Slf4j
@Service
abstract class FtpOperationTemplate<T, K> {
protected abstract K command(FTPClient ftpClient, T input) throws IOException;
public K execute(FTPClient ftpClient, T input) {
try {
ftpClient.connect("host", 22);
ftpClient.login("username", "password");
return command(ftpClient, input);
} catch (IOException ex) {
log.error("Something went wrong", ex);
throw new RuntimeException(ex);
} finally {
try {
ftpClient.logout();
ftpClient.disconnect();
} catch (IOException ex) {
log.error("Something went wrong while finally", ex);
}
}
}
}
- 列出ftp目錄listDirectories方法的實(shí)現(xiàn)
@Slf4j
@Service
class FtpOperationListDirectories extends FtpOperationTemplate<String, FTPFile[]> {
@Override
protected FTPFile[] command(FTPClient ftpClient, String input) throws IOException {
return ftpClient.listDirectories(input);
}
}
- 刪除文件deleteFile方法的實(shí)現(xiàn)
@Slf4j
@Service
class FtpOperationDeleteFile extends FtpOperationTemplate<String, Boolean> {
@Override
protected Boolean command(FTPClient ftpClient, String input) throws IOException {
return ftpClient.deleteFile(input);
}
}
- 實(shí)現(xiàn)FtpProvider接口
@RequiredArgsConstructor
@Slf4j
@Service
public class FtpProviderTemplateImpl implements FtpProvider {
private final FtpOperationTemplate<String, FTPFile[]> ftpOperationListDirectories;
private final FtpOperationTemplate<String, Boolean> ftpOperationDeleteFile;
private final FTPClient ftpClient;
public FTPFile[] listDirectories(String parentDirectory) {
return ftpOperationListDirectories.execute(ftpClient, parentDirectory);
}
public boolean deleteFile(String filePath) {
return ftpOperationDeleteFile.execute(ftpClient, filePath);
}
}
我們正在 FtpOperationTemplate? 上執(zhí)行方法 execute? 并在那里傳遞我們的參數(shù)。因此執(zhí)行方法的邏輯對于 FtpOperationTemplate 的每個(gè)實(shí)現(xiàn)都是不同的。
總結(jié)
我們現(xiàn)在來比較下上面種方式：
向 FtpProvider? 接口添加一個(gè)新方法，需要我們僅在一個(gè)地方進(jìn)行更改。我們可以輕松地將我們的 FtpProvider? 注入到其他服務(wù)中。此解決方案的強(qiáng)項(xiàng)可能是 @FtpOperation? 注釋，它可以在 FtpProvider 上下文實(shí)現(xiàn)之外使用，但是將 Ftp 操作的邏輯劃分到單獨(dú)的類中并不是一個(gè)好方法。
向接口 FtpProvider? 添加一個(gè)新方法，需要我們僅在一個(gè)地方進(jìn)行更改。我們可以輕松地將我們的 FtpProvider 注入到其他服務(wù)中。我們將ftp操作的邏輯封裝在一個(gè)類中。相對于上面的方式，我們也沒有用到AOP的庫，所以我個(gè)人還是比較推薦的。
向接口 FtpProvider? 添加一個(gè)新方法，需要我們在兩個(gè)地方進(jìn)行更改。我們需要添加一個(gè)新的類，會(huì)導(dǎo)致類爆炸，另外，我們還需要將實(shí)現(xiàn)注入到 FtpProvider。
如果是你，你會(huì)選擇哪種方式呢？還是有更好的方法？
