Clean Code in Small Companies

Transcription

1 Clean Code in Small Companies

2

3 Stock photo, not actual developer

4 Stock photo, not actual developer

5

6 Stock photo, not actual developer

7 Robert C. Martin Uncle Bob

8

9 1. Reading code is hard

10 1. Reading code is hard 2. We all have to read code

11 1. Reading code is hard 2. We all have to read code 3. Surprises are bad

12 Code in these Slides

13 $iamavariable

14 class UserController extends Controller { Class name Parent class name

15 class UserController extends Controller { private $membervariable; Access modifier

16 class UserController extends Controller { public function somemethod( Request $request ) { Method name Parameter type hint

17

18 A few words on testing... More on this later

19 class UserController { public function construct( UserBusinessLogic $userbusinesslogic ) {

20 function testregistration() {

21 function testregistration() { $userbusinesslogic = new UserBusinessLogicFake();

22 function testregistration() { $userbusinesslogic = new UserBusinessLogicFake(); $usercontroller = new UserController( $userbusinesslogic );

23 function testregistration() { $userbusinesslogic = new UserBusinessLogicFake(); $usercontroller = new UserController( $userbusinesslogic ); //Test the user controller

24 Dependency Injection Don t look for things!

25 class UserController extends Controller { /** name="user_account") */ public function accountaction(request $request) { if ( $this->container ->get('security.authorization_checker') ->isgranted('role_super_admin') ) { return $this->redirecttoroute('admin_dashboard'); // Other stuff here

26 class UserController extends Controller { /** name="user_account") */ public function accountaction(request $request) { if ( $this->container ->get('security.authorization_checker') ->isgranted('role_super_admin') ) { return $this->redirecttoroute('admin_dashboard'); // Other stuff here

27 $this->container ->get('security.authorization_checker') ->isgranted('role_super_admin')

28 $this->container ->get('security.authorization_checker') ->isgranted('role_super_admin')

29 $this->container ->get('security.authorization_checker') ->isgranted('role_super_admin')

30 $this->container ->get('security.authorization_checker') ->isgranted('role_super_admin')

31 UserController

32 UserController Magic?

33 UserController Magic? security.authorization_checker

34

35 class UserController extends Controller {

36 class UserController extends Controller {

37 class UserController { public function construct( ) {

38 class UserController { public function construct( SecurityAuthorizationChecker $securityauthorizationchecker ) {

39 class UserController { private $securityauthorizationchecker; public function construct( SecurityAuthorizationChecker $securityauthorizationchecker ) { $this->securityauthorizationchecker = $securityauthorizationchecker ;

40 class UserController { private $securityauthorizationchecker; public function construct( SecurityAuthorizationChecker $securityauthorizationchecker ) { $this-> securityauthorizationchecker = $securityauthorizationchecker; /** name="user_account") */ public function accountaction(request $request) { if ($this->securityauthorizationchecker->isgranted( 'ROLE_SUPER_ADMIN')) { return $this->redirecttoroute( 'admin_dashboard');

41 class UserController { private $securityauthorizationchecker; public function construct( SecurityAuthorizationChecker $securityauthorizationchecker ) { $this-> securityauthorizationchecker = $securityauthorizationchecker; /** name="user_account") */ public function accountaction(request $request) { if ($this->securityauthorizationchecker->isgranted( 'ROLE_SUPER_ADMIN')) { return $this->redirecttoroute( 'admin_dashboard');

42 Dependency Injectors Moving the Magic out of your Program

43 UserController UserBusinessLogic UserStorage

44 class UserController { public function construct( UserBusinessLogic $userbusinesslogic ) {

45 class UserController { public function construct( UserBusinessLogic $userbusinesslogic ) { class UserBusinessLogic { public function construct( UserStorage $userstorage ) {

46 class UserController { public function construct( UserBusinessLogic $userbusinesslogic ) { class UserBusinessLogic { public function construct( UserStorage $userstorage ) { class UserStorage {

47 $uc = new UserController( new UserBusinessLogic( new UserStorage() ) );

48 $injector = new Injector();

49 $injector = new Injector(); $uc = $injector->make(usercontroller::class);

50 class MySQLConnection { public function construct( string $server, string $username, string $password, string $db ) {

51 $injector->define(mysqlconnection::class, [ 'server' => 'localhost', 'user' => 'root', 'password' => 'changeme', 'db' => 'app' ]);

52 PHP: Auryn, Laravel Service Container, Symfony Service Container Java: Gource, Dagger, Dagger2, Opsbears Web Components DIC Python: dependency_injector Javascript: InversifyJS

53 class UserController extends Controller { /** name="user_account") */ public function accountaction(request $request) { if ( $this->container ->get('security.authorization_checker') ->isgranted('role_super_admin') ) { return $this->redirecttoroute('admin_dashboard'); // Other stuff here

54 class UserController extends Controller { /** name="user_account") */ public function accountaction(request $request) { if ( $this->container ->get('security.authorization_checker') ->isgranted('role_super_admin') ) { return $this->redirecttoroute('admin_dashboard'); // Other stuff here

55 class UserController extends Controller { /** name="user_account") */ public function accountaction(request $request) { if ( $this->injector ->make(securityauthorizationchecker::class) ->isgranted('role_super_admin') ) { return $this->redirecttoroute('admin_dashboard'); // Other stuff here

56 class UserController extends Controller { /** name="user_account") */ public function accountaction(request $request) { if ( $this->injector ->make(securityauthorizationchecker::class) ->isgranted('role_super_admin') ) { return $this->redirecttoroute('admin_dashboard'); // Other stuff here

57 Static Function Calls Might Be Bad For Your Code Quality

58 class UserController extends Controller { /** name="user_account") */ public function accountaction(request $request) { if ( $this->injector ->make(securityauthorizationchecker::class) ->isgranted('role_super_admin') ) { return $this->redirecttoroute('admin_dashboard'); // Other stuff here

59 class UserController extends Controller { /** name="user_account") */ public function accountaction(request $request) { if ( SecurityAuthorizationChecker ::isgranted('role_super_admin') ) { return $this->redirecttoroute('admin_dashboard'); // Other stuff here

60 $uc = new UserController();

61 Immutable Objects Avoiding Surprises

62 class User { private $id; public function setid($id) { $this->id = $id; public function getid() { return $this->id;

63 new User()

64 class User { private $id; public function setid($id) { $this->id = $id; public function getid() { return $this->id;

65 class User { private $id; public function setid($id) { $this->id = $id; public function getid() { return $this->id;

66 class User { private $id; public function construct($id) { $this->id = $id; public function getid() { return $this->id;

67 class UserStorage { private $users = []; public function store(user $user) { $this->users[$user->getid()] = $user;

68 class UserStorage { private $users = []; public function store(user $user) { $this->users[$user->getid()] = $user; public function retrieve($id) { if (isset($this->users[$id])) { return $this->users[$id]; else { throw new UserNotFoundException($id);

69 Less Code in One Class Your All-In-One Weightloss Program

70 class UserController { public function register() { public function search() { public function get() { public function update() { public function delete() {

71 Route::get( '/users', function ( ); ) { return 'User list';

72 Route::get( '/users', function ( UserBusinessLogic $userbusinesslogic ) { return 'User list'; );

73 class UserRegisterController { public function construct( UserBusinessLogic $userbusinesslogic ) { public function register() {

74 Static Typing Saves you from a **** ton of issues

75 function search( $needle, $haystack ) {

76 function search( string $needle, array $haystack ) {

77 JavaScript PHP Python Java Typescript phpstan mypy builtin

78 Strict Typing Because your String is not an Integer

79 PHP <?php declare(strict_types=1);

80 PHP <?php declare(strict_types=1); JavaScript Typescript

81 Structuring your Code Because your Code is not a Clown Car

82 /controller UserRegisterController.php UserListController.php /model /view

83 /user /controller UserRegisterController.php UserListController.php /business /storage /blog /controller /business /storage

84 Testing You test your code, right?

85 Application

86 User Interface Application

87 Test Code User Interface Application

88 Test Code User Interface Application Database Connector

89 Test Code User Interface Application Database Connector Test Database

90 Test Code User Interface Application Database Connector Test Database

91 Application

92 Test Code Application

93 Test Code Application Fake Database Connector

94 Test Code Application Fake Database Connector

95 Test Code User Interface Fake Application

96 function testgetshouldreturnuser(){ //region Setup $userstorage = new UserStorageFake(); $userstorage->backingstorage['test-user'] = UserFactory::create( "test-user", "Test User", "test@example.com", "*" ); $business = new UserGetBusinessLogicImpl($userStorage); //endregion //region Execute... //region Asset...

97 function testgetshouldreturnuser(){ //region Setup... //region Execute $user = $business->getbyid("test-user"); //endregion //region Assert assertequals("test-user", $user->getid()); //endregion

98 Putting it together Building an actual system

99 Many thanks to: Cristina Laskar

100

101

102

103 Single Page Application HTTP API Business Logic Storage MySQL or HSQLDB

104 Single Page Application HTTP Routing / Object Decoding API Business Logic Storage DataMapper / ORM MySQL or HSQLDB

105

106 Non-technical Ways Customer Communication is Important

107 UX design

108 More information Because one talk is not enough

109