【Java SpringBoot】Controllerの前処理、後処理の実装

Question

Spring MVC の実装において、前処理、後処理の設計がうまくいかず相談したいです。

まず、Controllerの構成をbefore(), execute(), after() の構成で考えております。
そして、Controllerの作成方針として1API=1Controllerとしてます。

各Controllerは親の存在があり、その親を必ず継承するよう対応する形になります。
親は複数種類存在し、各Controllerは必要となる親を継承する形になります。

以下、呼称を親を親Controller、それを継承するものを子Controllerとします。

上記の条件で実装するにあたって、
親Controllerクラスにbefore(), after()を持たせ
子Controllerクラスにexecute()を実装するとします。

execute()には、@RequestMapping("/uri")を付与します。

Clientからリクエストが送信された際に、execute()が呼ばれます。
が、その際にbefore()が呼ばれる設計としたいです。
また、execute()の処理の終了後にafter()が呼ばれるようにしたいです。

Spring AOP 使用し実装に試みたものの、before()の実装がAdviceクラスになってしまい、
親Controllerでの実行は無理そうでした。

before()内に、Clientからのリクエストメッセージを親クラスのフィールドに持たせる方針であるため、
どうしても親クラス内でbefore()を実行したいです。
(レスポンスも同様にafter()にて設定を行いたい）

なにか良い方法はありませんでしょうか。

以下、イメージとなる実装を記載します。

@Controller
@RequestMapping("/URI_ACCOUNT")
public class LoginController extends BaseBackendController {

    @Autowired
    AccountManageService service;

    @Override
    @RequestMapping("/URI_LOGIN")
    public void execute() {

        // リクエスト情報取得
        UserInfoDto userInfoDto = (UserInfoDto) super.getRequestData();

        // ログイン処理
        service.login(userInfoDto);
    }

}

@RestController
public abstract class BaseBackendController implements BaseController {

    @Autowired
    private RequestDto requestDto;
　　
　　/** 前処理 */// ここで本来はexecuteの呼び出しを行った際に最初に呼ばれる想定
    public void before() {
　　　　　// Requestメッセージ取得
         RequestAttributes attributes = RequestContextHolder.getRequestAttributes();
         ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes)
         attributes;
         HttpServletRequest request = servletRequestAttributes.getRequest();
         try {
         　　//　RequestBody取得　　　　　　 
            requestData.setRequestDto(
                 request.getReader().lines().collect(Collectors.joining("\r\n"));
         } catch (IOException e) {
         　　throw new RuntimeException(e);
         }
    }

    public void after() {}

    protected Request getRequestData() {
        return this.requestDto.getRequest();
    }
}

お手数おかけしますが、お助け願います。

Comments

[退会済みユーザー]

で アフターは何をしたいの?

[shafi]

AfterはControllerの後処理、Excute()の後処理を実行したいです。
基本的にはResponseの処理を埋め込もうと考えていますが、その設計はまだ起こしていない状態です。

[退会済みユーザー]

おこしてないのになぜアフターをやりたいのか

[shafi]

共通クラスを実装を考えています。
親クラスに共通して持つものとしてBefore、Afterのセットで持たせようと考えております。
なのでAfterは定義上用意していますが、
例えば、Beforeでファイルオープン。
Afterでファイルクローズなどの処理想定しています。
厳密には設計途上の段階です。

Answer 1

例えば、Beforeでファイルオープン。

Afterでファイルクローズなどの処理想定しています。

上記を達成できる バッドノウハウ

※ Spring の利点が著しく損なわれますｗ

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class ControllerBase {

	Logger logger = LogManager.getLogger();

	public void before() {
		logger.info("before");
	}

	public void after() {
		logger.info("after");
	}

// bean (Controller）に DI完了後に動作
// before を呼ぶ
	@PostConstruct
	public final void postConstruct() {
		this.before();
	}

// bean (Controller）が破棄されるときに動作
// after を呼ぶ
	@PreDestroy
	public final void preDestroy() {
		this.after();
	}

}

import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Scope("request")
@Controller
public class IndexController extends ControllerBase {

	@GetMapping("/")
	@ResponseBody
	public String index() {
		return "index";
	}

}

Comments

[shafi]

@asahina1979
ご回答ありがとうございます。
一つの案として検討させていただきます。
DI完了時、破棄時に処理を割り込めること自体知りませんでした。
ありがとうございます。

[退会済みユーザー]

書いてある通り「バッドノウハウ」だからね

Answer 2

SpringMVCの実装ポリシーとしてはControllerの前処理や後処理は、@ControllerAdviceで実装するものです。これに倣わずに独自拡張をした場合は、Controllerの初期処理も気にしなければなりませんし、それでもbeforeやafterを実装したいのでしたら、Springの制御層に手をいれれば可能ですが、その場合はSpringMVCやSpringBootのバージョンアップにより動作しなくなる恐れがあるでしょう。

https://qiita.com/kazuki43zoo/items/757b557c05f548c6c5db

Comments

[shafi]

@A-pZ
ご回答ありがとうございます。
設計当初では、Spring AOPのAceptを利用し、BaseControllerでの実装を試してみましたが、
うまくいかずご相談した形でした。
BaseControllerを継承した子クラスで、execute()の実装のみを行い、ほかの初期処理や共通処理等はすべて親クラスに持たせて子クラスの負担をと考えたのですが難しい場合は今回の件はやめる検討もしています。
みなさんの意見を拝見する限り、難しいため再設計の形になりそうですね。
制御層まで手を入れる予定はありません。

Answer 3

Spring (Boot)でコントローラーの前後に処理を挟み込みたい場合は、AOPのほかに

• Filter
• Interceptor

などの利用が考えられますが、AOPの利用が設計上無理ということであれば、これらも利用に適さないかもしれません。
なので、設計の方を少し見直してみてはどうでしょうか？という提案レベルの回答になります。

以下はInterceptorを利用した方法の一案になります。

BaseBackendControllerの代わりになるBaseBackendServiceを実装します。
（before/afterメソッドの引数の種類やクラスの命名に特に意味はありません。実装をイメージしやすいように考えました。）

@Service
public class BaseBackendService implements BaseBackend {

  public void before(HttpServletRequest request, HttpServletResponse response) {
    // 前処理
  }

  public String after(HttpServletRequest request, HttpServletResponse response) {
    // 後処理

    // 戻り先のビューを決定
    String viewName = "account/" + " ... ";

    return viewName;
  }

  public void doCommonBackend() {
    // 共通処理
  }

}

インターセプターの前後の処理で、BaseBackendService#before、BaseBackendService#afterを呼び出します。この例ではafterメソッドがビュー名を返すので、それをmodelAndView.setViewNameに指定します。

@Component
public class BaseBackendInterceptor implements HandlerInterceptor {

  private final BaseBackendService baseBackendService;

  public BaseBackendInterceptor(BaseBackendService baseBackendService) {
    this.baseBackendService = baseBackendService;
  }

  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    baseBackendService.before(request, response);
    return true;
  }

  @Override
  public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    String viewName = baseBackendService.after(request, response);

    // ここでビューを指定
    modelAndView.setViewName(viewName);
  }

}

インターセプターを登録します。この例では/account/**というアクセスのときに処理されるように登録しています。

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

  private final BaseBackendInterceptor baseBackendInterceptor;

  public WebMvcConfig(BaseBackendInterceptor baseBackendInterceptor) {
    this.baseBackendInterceptor = baseBackendInterceptor;
  }

  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(baseBackendInterceptor).addPathPatterns("/account/**");
  }

}

コントローラーの実装です。ここではビューは指定しないので戻り値の型はvoidです。

@Controller
@RequestMapping("/account")
public class LoginController {

  @RequestMapping("/login")
  void execute() {
    // なにかの処理
  }

}

BaseBackendServiceに実装した何かの処理をコントローラーでも呼び出したい場合は、BaseBackendServiceをインジェクトして呼び出すことができます。
（ただし、この実装にするとインターセプターを利用する意味が無くなるのですが。）

@Controller
@RequestMapping("/account")
public class LoginController {

  private final BaseBackendService baseBackendService;

  public LoginController(BaseBackendService baseBackendService) {
    this.baseBackendService = baseBackendService;
  }

  @RequestMapping("/login")
  void execute(HttpServletRequest request, HttpServletResponse response) {
    // baseBackendService.before(request, response);

    // なにかの処理

    // 共通処理
    baseBackendService.doCommonBackend();

    // なにかの処理

    // String viewName = baseBackendService.after(request, response);
    // return viewName;
  }

}

簡単ですが案は以上になります。
ちなみに、やりたいことが認証周りであれば独自の認証処理よりSpring Securityを利用するほうがいいかもしれません。

Comments

[退会済みユーザー]

ぼくのかんがえた（以下略）の人がどこまで納得するかだよなぁ

[shafi]

@rubytomato
ご回答ありがとうございます。
今一度、インタセプタの検討して再設計を検討してみます。
インタセプタ内でフィールド等の保持は難しいですが、
リクエストを受けたControllerにて自分で取ってもらう形とします。
ありがとうございました。