egovframe-compatibility

eGovFrame Compatibility Rules

Overview

eGovFrame 4.x/5.x adds constraints on top of Spring conventions for government system development. Only eGovFrame-specific rules are documented here — Spring Framework knowledge assumed.

Scope: Java projects using org.egovframe.rte.* (eGovFrame 4.x+). Excludes egovframework.rte.* (3.10 and earlier), non-Java code, and frontend concerns.

---

Controller Layer

Target: @Controller, @RestController, and Servlet code only when Spring MVC is impractical and justified.

Rules:

1. Map handlers with Spring MVC annotations.
2. Do not inject or call DAO classes directly, including subclasses of SqlMapClientDaoSupport, SqlSessionDaoSupport, and HibernateDaoSupport.
3. No direct NoSQL, MQ, or cache access from controllers.
4. Route business logic through an injected service interface.

// ✅ Correct
@Controller
@RequestMapping("/sample")
public class SampleController {
    @Autowired
    private SampleService sampleService;

    @GetMapping("/list")
    public String list(Model model) {
        model.addAttribute("list", sampleService.selectList());
        return "sample/list";
    }
}

// ❌ DAO injected directly — forbidden
@Controller
public class SampleController {
    @Autowired
    private SampleMapper sampleMapper; // ❌ inject Service, not DAO
}

// ❌ Business logic handled inside controller — forbidden
@GetMapping("/calc")
public String calc(Model model) {
    int result = heavyBusinessCalculation(); // ❌ delegate to Service
    model.addAttribute("result", result);
    return "sample/result";
}

---

Service Layer

Target: @Service or @Component business classes, excluding tests.

Rules:

1. Each service implementation must extend EgovAbstractServiceImpl, directly or through a base class.
2. Each service implementation must implement a dedicated service interface.

Why the interface matters: eGovFrame AOP relies on Java Dynamic Proxy, not CGLIB — class-only services cannot be proxied.