...
Proposed Generic Structure
| Package | Scope | Notes | |
|---|---|---|---|
| 1 | api | all classes that are required for northbound interfaces | |
| 2 | api\feature | all API classes that are specific to a given feature | |
| 3 | api\feature\models | all data-holder type classes for the API specific to the feature | do NOT add data objects that are only used in the impl! |
| 4 | api\feature\exceptions | all exception classes that are specific to a given feature | do think 'ahead': is the exception rally going to be unique for this feature! If in doubt it probably should go into api\exception. Because moving it later would be a backward incompatible change! |
| 5 | api\models | all data-holder type classes for the API that can be shared between features | |
| 6 | api\feature\exceptions | all exception classes that can be shared between features and at least oen feature exposes on the API | |
| 7 | impl | all classes that are NOT exposed on the northbound interface and are unique to just one feature | since these classes are NOT exposed on the API it is OK to move them to the common utils\ package only when needed (i.e. later) since this would not be backward incompatible |
| 8 | api\feature | all implementation classes that are specific to a given feature | |
| 9 | exceptions | all exception classes that are can be shared between given features and are NOT exposed on any API | |
| 10 | utils | all implementation classes that can be shared between features |
| Code Block | ||
|---|---|---|
| ||
api\feature1\SomeService.class api\feature1\models\SpecificModelClass api\feature1\exceptions\SpecificException.class api\feature2\SomeService.class api\feature2\models\SpecificModelclass api\feature2\exceptions\SpecificException.class api\models\CommonModel.class api\exeptions\CommonException.class impl\feature1\SomeServiceImpl.class impl\feature1\helperPackage\SpecificHelper.class impl\feature2\SomeServiceImpl.class exceptions\someInternalException.class utils\CommonHelper.class |
...