CSC509 Lecture 14

Software Design
Final Review
(202412)

Transcript

1. Dr. Javier Gonzalez-Sanchez javiergs@calpoly.edu www.javiergs.info office: 14 -227 CSC 508/9 Software Engineering (Design & Deployment) Lecture 14. Final Review
2. Grading 2
3. Grading
4. jgs The following slides shows some examples
 related to some topics
 
 
 This is NOT a comprehensive list of topics

5. Key Ideas Lecture 01
6. Alternative Solution 6 New Yorker, June 1992 "Most software today is very much like an Egyptian pyramid with millions of bricks piled on top of each other, with no structural integrity, but just done by brute force and thousands of slaves". – Alan Kay. Pioneering work on object-oriented programming ACM Queue. Vol. 2, No. 9 - Dec/Jan 2004-2005
7. Idea 7 OOAD, Grady Booch, 2007
8. Lecture 01 8
9. Key Ideas Lecture 02-05, 11
10. Blueprint Architecture Design Code
11. Model-View-Controller 11
12. Drafting an Implementation 12
13. Client-Server 13
14. Homework 14 Brain View Controller Client Blackboard PostOffice Model Server Publisher Subscriber
15. Team 2. Affect Recognition Module Affect Recognition (speed) 15
16. Team 3. Head Tracking Module Head Movement 16
17. Team 4. Cobot Universal Robotics - eSeries 17
18. Team 5. Control Dashboard Hub 18
19. Key idea • Keep it Simple - over-designing the system is as bad as their absence when needed. • A design that is more than what we need smells. • Design principles are not a perfume to be liberally scattered all over the system. 19
20. Does this smells? 20
21. Key Ideas Lecture 06
22. Clean Code Readability • DRY • KIS • SRP • Comments • Error Handling with a Logger 22 Metrics • LOC (eLOC, lLOC) • CC • A • I • D
23. • Instability = Cout (Cin + Cout) Stable Abstraction Principle (SAP) 23
24. Example 24
25. Structural Metrics 26 Instability = Cout (Cin + Cout) D = A + I – 1
26. Key Ideas Lecture 06, 11
27. Relationships 29 Association Directed Association Reflexive Association Multiplicity Aggregation Composition Generalization Realization
28. Example public class B implements E { public B() { C c1 = new C(); } public void method() { B b = new B(); b.sleep(); } } public class Y { A [] a = new A[5]; } public class A extends B { C c1, c2; public A() { c1 = new C(); } public void method() { D d = new D(); d.working(); } } public class X { public void m() { B var = new A(); double x = Math.sqrt(5); } } 30
29. Example 31 Write the Source Code
30. Design Principles There are five key design principles to consider in Object-Oriented: • Single Responsibility Principle (SRP) • Open-Closed Principle (OCP) • Liskov Substitution Principle (LSP) • Interface Segregation Principle (ISP) • Dependency Inversion Principle (DIP) 32
31. DIP Example 33
32. GoF Patterns 34
33. Tools Lecture 08, 10, 12
34. POM.xml 36
35. src/main/resources/logback.xml 37 https://github.com/CSC3100/Tool-Logging
36. Good Idea 38 message 01 message 02 message 03 message 04 message 05
37. logs.betterstack.com 39
38. Docker | Steps 40 2. A package that includes everything needed to run software, including the code, runtime, libraries, dependencies, and configuration files. 3. A container is a runtime instance of an image. It encapsulates the execution environment for a specific application or process, including the filesystem, environment variables, network settings, and runtime options. 1. A text file that contains instructions for building a Docker image
39. Key Ideas Lecture 13
40. Environment
41. Final Project Presentation
42. Wednesday, December 11 a) Final Version of your Source Code - submit your Java files b) Software Design - your UML class diagram c) Metrics (Code and Structure) d) Links to your GitHub repository e) Link to your video of the Final Presentation 44
43. Demo Part 1
44. First Act – The product for the Customer Demo of your project. Show your project running. :: notes :: you can, additionally, talk (briefly) about your proposal, i.e., the next features to be added 46
45. Architecture and Design Part 2
46. Second Act – Software Design Show your architecture and class diagram. (Show what is important and make it easy to read for the audience) :: notes :: (you can use colors for the newly added classes) • What did you do that make this design “good”. • Do you achieve SOLID? • Do you improve A, I, or D? (show the 2D plot regarding where your classes are in terms of the pain zone) 48
47. Part 2. The product • Describe your architecture ( a diagram with boxes is fine) • Describe your design. Could it be easy for a new developer to reuse, modify or extend what you have created? • Show a class diagram (Explain it and describe the details) • Be sure the diagram and code match. • What components were developed by each team member? What were the criteria for splitting the work (components, classes, methods)? 49
48. Part 2. The product • Docker? • Libraries? 50
49. Code Part 3
50. Part 2. The product • Source code clean, DRY, and KIS • Code Metrics: LOC, eLOC, lLOC, CC • Structure Metrics: Abstractness, Instability, Distance • Does the product have a “good” quality? • What features were Unit Tested? • Services? 52
51. Structural Metrics 53 Abstract concrete Stable Hard to Change Only incoming dependencies Unstable Changeable Only outgoing dependencies
52. Deployment Part 4
53. Deployment Think about the following regarding deployment: •Could someone download the latest version from the GitHub release and know how to run it? •Consider using a JMenuBar, JPopupMenu •Consider making your JAR file executable (see next) 55
54. Deployment | POM.XML 56
55. Usability •Could someone know how to use it? •Where to start? •What the project is about? •Take advantage of your README.md (beauIfy it) @see https://docs.github.com/en/repositories/ 57
56. Peers Not for the Video
57. (self and peer evaluation) • NOT for the video. A link will be provided for this • (self and peer evaluation) What should be your grade and the grade of each of your teammates? 59
58. Questions 60
59. CSC 509 Software Engineering Javier Gonzalez-Sanchez, Ph.D. javiergs@calpoly.edu Fall 2024 Copyright. These slides can only be used as study material for the class CSC509 at Cal Poly. They cannot be distributed or used for another purpose.